API#

Reference#

A complete API reference in the Swagger UI is available at:

https://mainfluxlabs.github.io/mainflux/docs/swagger

Users#

Create Token#

To log in to the Mainflux system, you need to create a user_token. The obtained token is used for access control in the system.

Must-have: registered email and password

curl -s -S -i -X POST -H "Content-Type: application/json" http://localhost/tokens -d '{"email":"<user_email>",
"password":"<user_password>"}'

Response:

HTTP/1.1 201 Created
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:07:18 GMT
Content-Type: application/json
Content-Length: 281
Connection: keep-alive
Strict-Transport-Security: max-age=63072000; includeSubdomains
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: *
Access-Control-Allow-Headers: *

{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MTU0MjQ4MzgsImlhdCI6MTYxNTM4ODgzOCwiaXNzIjoibWFpbmZsdXguYXV0aCIsInN1YiI6InRlc3RAZW1haWwuY29tIiwiaXNzdWVyX2lkIjoiZDc4MmI0MmItZTMxNy00Y2Q3LTlkZDAtNGUyZWEwZjM0OWM4IiwidHlwZSI6MH0.TAQxV6TImKw06RsK0J11rOHiWPvexEOA4BNZnhLhtxs"}

Create User#

The predefined user within the Mainflux system is the root admin. In order to add users to the system, the root administrator must create accounts for them.

Must-have: email, password (password must contain at least 8 characters) and user_token

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/users -d '{"email":"<user_email>", "password":"<user_password>"}'

Response:

HTTP/1.1 201 Created
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:06:45 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Location: /users/d782b42b-e317-4cd7-9dd0-4e2ea0f349c8
Strict-Transport-Security: max-age=63072000; includeSubdomains
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: *
Access-Control-Allow-Headers: *

View User#

You can always check the user entity that is logged in by entering the user ID and user_token.

Must-have: user_id and user_token

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/users/<user_id>

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:09:47 GMT
Content-Type: application/json
Content-Length: 85
Connection: keep-alive
Strict-Transport-Security: max-age=63072000; includeSubdomains
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: *
Access-Control-Allow-Headers: *

{"id":"d782b42b-e317-4cd7-9dd0-4e2ea0f349c8","email":"test@email.com"}

List Users#

You can get all users in the database by calling this function

Must-have: user_token

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/users

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:11:28 GMT
Content-Type: application/json
Content-Length: 217
Connection: keep-alive
Strict-Transport-Security: max-age=63072000; includeSubdomains
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: *
Access-Control-Allow-Headers: *

{"total":2,"offset":0,"limit":10,"Users":[{"id":"4bf4a13a-e9c3-4207-aa11-fe569986c301","email":"admin@example.com"},{"id":"d782b42b-e317-4cd7-9dd0-4e2ea0f349c8","email":"test@email.com"}]}

Update User#

Updating user's metadata

Must-have: user_token

curl -s -S -i -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/users -d
'{"metadata":{"foo":"bar"}}'

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:15:31 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Strict-Transport-Security: max-age=63072000; includeSubdomains
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: *
Access-Control-Allow-Headers: *

Change Password#

Changing the user password can be done by calling the update password function

Must-have: user_token, old_password and password (new_password)

curl -s -S -i -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/password -d '{"old_password":"<old_password>", "password":"<new_password>"}'

Response:

HTTP/1.1 201 Created
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:17:36 GMT
Content-Type: application/json
Content-Length: 11
Connection: keep-alive
Strict-Transport-Security: max-age=63072000; includeSubdomains
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: *
Access-Control-Allow-Headers: *

Orgs#

Create Org#

To create an org, you need the org name, description, metadata and a user_token

Must-have: user_token

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/orgs -d '{"name": "<org_name>", "description": "<org_description>", "metadata": {}}'

Response:

HTTP/1.1 201 Created
Content-Type: application/json
Location: /orgs/25da5d7a-d3f5-435e-bcad-0cf22343121a
Date: Fri, 14 Jul 2023 14:03:14 GMT
Content-Length: 0

View Org#

To view an org, you need the org ID and a user_token

Must-have: user_token and org_id

curl -s -S -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/orgs/<org_id>

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:22:48 GMT
Content-Length: 250

{"id":"25da5d7a-d3f5-435e-bcad-0cf22343121a","name":"org_name","owner_id":"a08bd22c-916d-4ed1-8ca4-8d32ede58822","description":"org_description","created_at":"2023-07-14T14:03:14.897Z","updated_at":"2023-07-14T14:03:14.897Z"}

Update Org#

To update an org, you need the org ID, name, description, metadata and a user_token

Must-have: user_token and org_id

 curl -s -S -i -X PUT -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>"  http://localhost/orgs/<org_id> -d '{"name": "<org_name>", "description": "<org_desc>", "metadata":{}}'

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:41:23 GMT
Content-Length: 0

Delete Org#

To delete an org, you need the org ID and a user_token

Must-have: user_token and org_id

curl -s -S -i -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/orgs/<org_id>

Response:

HTTP/1.1 204 No Content
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:47:24 GMT

List Orgs#

To list orgs, you need a user_token Only admin users can list all orgs, other users can only list orgs they are members of.

Must-have: user_token

curl -s -S -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/orgs

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 14 Jul 2023 20:43:58 GMT
Content-Length: 456

{"limit":10,"offset":0,"total":2,"orgs":[{"id":"9883c534-eeb5-4e30-aec9-bd6cf1639f95","name":"org_name_1","owner_id":"a08bd22c-916d-4ed1-8ca4-8d32ede58822", "metadata":{"meta":"test1"},"created_at":"2023-07-13T09:35:40.116Z","updated_at":"2023-07-13T10:58:32.523Z"},{"id":"49114ab9-acbb-4d0b-be01-0dc2f396136c","name":"org_name_2","owner_id":"a08bd22c-916d-4ed1-8ca4-8d32ede58822","metadata":{"meta":"test2"},"created_at":"2023-07-13T09:29:41.718Z","updated_at":"2023-07-13T11:08:22.586Z"}]}

Org Memberships#

Create Memberships#

To create org memberships, you need the org ID, member email addresses, their roles and a user_token.

Must-have: user_token, org_id, email and role

The org_memberships field is a list of membership objects, each representing a user you want to add to the organization.

Each object must include:

• email: The email address of the user to be added to the organization.
  Must refer to an existing registered user.

• role: The role you want to assign to the user within the organization.
  Only roles listed in the Roles Section are allowed.

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/orgs/<org_id>/memberships -d '{"org_memberships":[{"email": "<user_email>","role": "user_role"}]}'

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 17 Jul 2023 08:24:44 GMT
Content-Length: 0

Remove Memberships#

To remove org memberships, you need the org ID, member IDs and a user_token

Must-have: user_token, org_id and member_id

curl -s -S -i -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/orgs/<org_id>/memberships -d '{"member_ids":["<member_id>"]}'

Response:

HTTP/1.1 204 No Content
Content-Type: application/json
Date: Mon, 17 Jul 2023 08:44:58 GMT

Update Memberships#

To update org memberships, you need the org ID, member email addresses, their new roles and a user_token.

Must-have: user_token, org_id, email and role

The org_memberships field is a list of membership objects representing users whose roles you want to update.

Each object must include:

• email: The email address of an existing member whose role is being changed.
• role: The new role to assign. Only roles listed in the Roles Section are allowed.

curl -s -S -i -X PUT -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/orgs/<org_id>/memberships -d '{"org_memberships":[{"email": "<user_email>", "role":"new_role"}]}'

View Membership#

To view org membership, you need the org ID, member ID and a user_token

Must-have: user_token, member_id, org_id

curl -s -S -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/orgs/<org_id>/members/<member_id>

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 24 Mar 2025 09:10:20 GMT
Content-Length: 87

{"member_id":"a08bd22c-916d-4ed1-8ca4-8d32ede58822","email":"user@example.com","role":"owner"}

List Memberships#

To list org memberships, you need the org ID and a user_token

Must-have: user_token and org_id

curl -s -S -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/orgs/<org_id>/memberships

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 17 Jul 2023 09:13:22 GMT
Content-Length: 235

{"limit":10,"offset":0,"total":2,"org_memberships":[{"member_id":"a08bd22c-916d-4ed1-8ca4-8d32ede58822","email":"user@example.com","role":"owner"},{"member_id":"34cf0a14-dc23-42ed-87bd-fa7ecc205bc2","email":"user_2@example.com","role":"admin"}

Groups#

Create Group#

To create a group, you need the group name, description, metadata, org_id and a user_token

Must-have: org_id, user_token

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/svcthings/orgs/<org_id>/groups -d '{"name": "<group_name>", "description": "<group_description>", "metadata": {}}'

Response:

HTTP/1.1 201 Created
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 16:58:09 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Location: /groups/01F0EH61SA7C7NDKWYCXVG7PWD
Access-Control-Expose-Headers: Location

View Group#

Get a group entity for a logged-in user

Must-have: user_token and group_id

curl -s -S -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/groups/<group_id>

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 17:06:48 GMT
Content-Type: application/json
Content-Length: 264
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"5316d843-abf8-4db4-93fd-bdc8917d42ec","org_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"group_name","description":"desc","created_at":"2021-03-10T16:58:09.579Z","updated_at":"2021-03-10T16:58:09.579Z"}

List Groups#

Get all groups, list requests accepts limit and offset query parameters

Must-have: user_token

curl -s -S -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/groups

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 17:09:28 GMT
Content-Type: application/json
Content-Length: 573
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":2,"limit":10,"offset":0,"groups":[{"id":"5316d843-abf8-4db4-93fd-bdc8917d42ec","org_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"group_name","description":"desc","created_at":"2021-03-10T16:58:09.579Z","updated_at":"2021-03-10T16:58:09.579Z"},{"id":"2513d843-abf8-4db4-93fd-bdc8917d42mm","org_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"group_name_1","description":"desc","created_at":"2021-03-10T17:07:52.13Z","updated_at":"2021-03-10T17:07:52.13Z"}]}

List Groups by Org#

Get groups by a specific organization

Must-have: user_token, org_id

curl -s -S -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/svcthings/orgs/<org_id>/groups

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Mon, 24 Mar 2025 15:10:28 GMT
Content-Type: application/json
Content-Length: 573
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":2,"limit":10,"offset":0,"groups":[{"id":"5316d843-abf8-4db4-93fd-bdc8917d42ec","org_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"group_name","description":"desc","created_at":"2021-03-10T16:58:09.579Z","updated_at":"2021-03-10T16:58:09.579Z"},{"id":"2513d843-abf8-4db4-93fd-bdc8917d42mm","org_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"group_name_1","description":"desc","created_at":"2021-03-10T17:07:52.13Z","updated_at":"2021-03-10T17:07:52.13Z"}]}

Update Group#

Update group entity

Must-have: user_token, group_id

curl -s -S -i -X PUT -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/groups/<group_id> -d '{"name": "<group_name>"}'

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 17:11:51 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Access-Control-Expose-Headers: Location

Delete Group#

Delete a group entity

Must-have: user_token, group_id

curl -s -S -i -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/groups/<group_id>

Response:

HTTP/1.1 204 No Content
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 17:14:13 GMT
Content-Type: application/json
Connection: keep-alive
Access-Control-Expose-Headers: Location

View Group by Thing#

Get a group entity by thing

Must-have: user_token, thing_id

curl -s -S -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/things/<thing_id>/groups

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 17:06:48 GMT
Content-Type: application/json
Content-Length: 264
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"5316d843-abf8-4db4-93fd-bdc8917d42ec","org_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"group_name","description":"desc","created_at":"2021-03-10T16:58:09.579Z","updated_at":"2021-03-10T16:58:09.579Z"}

View Group by Profile#

Get a group entity by profile

Must-have: user_token, profile_id

curl -s -S -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/profiles/<profile_id>/groups

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 17:06:48 GMT
Content-Type: application/json
Content-Length: 264
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"5316d843-abf8-4db4-93fd-bdc8917d42ec","org_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"group_name","description":"desc","created_at":"2021-03-10T16:58:09.579Z","updated_at":"2021-03-10T16:58:09.579Z"}

Group Memberships#

Create Memberships#

To create group memberships, you need the group ID, member IDs, their roles and a user_token.

Must-have: user_token, group_id, member_id and role

The group_memberships field is a list of membership objects, each representing a user you want to add to the group.

Each object must include:

• member_id: The UUID of the user to be added to the group.
  Must refer to an existing registered user.

• role: The role to assign to the user within the group.
  Only roles listed in the Roles Section are allowed.

curl -isSX POST http://localhost/groups/<group_id>/memberships -d '{"group_memberships":[{"member_id":"123e4567-e89b-12d3-a456-426614174000","role":"viewer"}]}' -H "Authorization: Bearer <user_token>" -H 'Content-Type: application/json'

Response:

HTTP/1.1 201 Created
Content-Type: application/json
Date: Wed, 03 Nov 2021 13:00:14 GMT
Content-Length: 3

{}

Remove Memberships#

To remove group memberships, you need the group ID, member IDs and a user_token

Must-have: user_token, group_id, member_ids

curl -isSX PATCH http://localhost/groups/<group_id>/memberships -d '{"member_ids":["987fbc97-4bed-5078-9f07-9141ba07c9f3","c9bf9e57-1685-4c89-bafb-ff5af830be8a"]}' -H "Authorization: Bearer <user_token>" -H 'Content-Type: application/json'

Response:

HTTP/1.1 204 No Content
Content-Type: application/json
Date: Wed, 03 Nov 2021 13:00:05 GMT

Update Memberships#

To update group memberships, you need the group ID, member IDs, new roles and a user_token.

Must-have: user_token, group_id, member_id, role

The group_memberships field is a list of membership objects representing users whose roles you want to update.

Each object must include:

• member_id: The UUID of an existing group member whose role you want to change.

• role: The new role to assign. Only roles listed in the Roles Section are allowed.

curl -s -S -i -X PUT -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/groups/<group_id>/memberships -d '{"group_memberships":[{"member_id":"123e4567-e89b-12d3-a456-426614174000","role":"editor"}]}'

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 17:11:51 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Access-Control-Expose-Headers: Location

List Memberships#

To list group memberships, you need the group ID and a user_token

Must-have: user_token, group_id

curl -s -S -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/groups/<group_id>/memberships

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 17:09:28 GMT
Content-Type: application/json
Content-Length: 225
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":2,"limit":10,"offset":0,"group_memberships":[{"member_id":"5316d843-abf8-4db4-93fd-bdc8917d42ec","email":"user@gmail.com","role":"viewer"},{"member_id":"2513d843-abf8-4db4-93fd-bdc8917d42mm","email":"user2@gmail.com","role":"editor"}]}

Profiles#

Create Profile with external ID#

A profile is a set of configuration parameters that can be applied to a Thing within the same group. To create a profile with external ID, the user needs to provide a UUID v4 format unique ID, group_id, metadata, config and a user_token. The detailed configuration of the Profile Config can be found at Profile Config.

Must-have: user_token,group_id

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/groups/<group_id>/profiles -d '[{"id": "<xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx>","name": "<profile_name>","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}}]'

Response:

HTTP/1.1 201 Created
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:26:51 GMT
Content-Type: application/json
Content-Length: 204
Connection: keep-alive
Location: /profiles/db4b7428-e278-4fe3-b85a-d65554d6abe9
Access-Control-Expose-Headers: Location

{"profiles":[{"id":"<xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx>","name":"profile_name","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}}]}

Create Profiles#

The same as creating a profile with external ID the user can create multiple profiles at once by providing UUID v4 format unique ID in a series of profiles together with a user_token and <group_id>.

Must-have: user_token, group_id and profiles

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/groups/<group_id>/profiles -d '[{"name": "<profile_name_1>"}, {"name": "<profile_name_2>","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}}]'

Response:

HTTP/1.1 201 Created
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:28:10 GMT
Content-Type: application/json
Content-Length: 352
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"profiles":[{"id":"b8073d41-01dc-46ad-bb26-cfecc596c6c1","name":"profile_name_1","group_id":"123e4567-e89b-12d3-a456-426614174000"},{"id":"2200527a-f590-4fe5-b9d6-892fc6f825c3","name":"profile_name_2","group_id":"123e4567-e89b-12d3-a456-426614174000","metadata":{"key":"val"},"config":{"content-type":"application/json"}}]}

Create Profiles with external ID#

You can create multiple profiles with external ID at once

Must-have: user_token, group_id and at least 2 profiles

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/groups/<group_id>/profiles -d '[{"id": "<xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx1>","name": "<profile_name_1>","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}}, {"id": "<xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx2>","name": "<profile_name_2>","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}}]'

Response:

HTTP/1.1 201 Created
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:28:10 GMT
Content-Type: application/json
Content-Length: 398
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"profiles":[{"id":"<xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx1>","name":"profile_name_1","group_id":"123e4567-e89b-12d3-a456-426614174000","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}},{"id":"<xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx2>","name":"profile_name_2","group_id":"123e4567-e89b-12d3-a456-426614174000","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}}]}

View Profile#

Get a profile entity for a logged-in user

Must-have: user_token and profile_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/profiles/<profile_id>

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:29:49 GMT
Content-Type: application/json
Content-Length: 188
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"db4b7428-e278-4fe3-b85a-d65554d6abe9","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"profile_name","metadata":{"key":"val"},"config":{"content-type":"application/json"}}

View Profile by Thing#

Get a profile by a specific thing

Must-have: user_token and thing_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/things/<thing_id>/profiles

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Mon, 24 Mar 2025 11:20:10 GMT
Content-Type: application/json
Content-Length: 188
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"db4b7428-e278-4fe3-b85a-d65554d6abe9","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"profile_name","metadata":{"key":"val"},"config":{"content-type":"application/json"}}

List Profiles#

Get all profiles that the user can access, list requests accepts limit and offset query parameters

Must-have: user_token

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/profiles

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:30:34 GMT
Content-Type: application/json
Content-Length: 493
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":3,"offset":0,"limit":10,"profiles":[{"id":"db4b7428-e278-4fe3-b85a-d65554d6abe9","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"profile_name","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}},{"id":"b8073d41-01dc-46ad-bb26-cfecc596c6c1","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"profile_name_1","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}},{"id":"2200527a-f590-4fe5-b9d6-892fc6f825c3","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"profile_name_2","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}}]}

List Profiles by Group#

Get all profiles by a certain group where the user has access

Must-have: user_token, <group_id>

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/groups/<group_id>/profiles

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:30:34 GMT
Content-Type: application/json
Content-Length: 427
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":2,"offset":0,"limit":10,"profiles":[{"id":"b8073d41-01dc-46ad-bb26-cfecc596c6c1","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"profile_name_1","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}},{"id":"2200527a-f590-4fe5-b9d6-892fc6f825c3","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"profile_name_2","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}}]}

List Profiles by Org#

Get all profiles by a certain organization

Must-have: user_token, <org_id>

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/svcthings/orgs/<org_id>/profiles

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Mon, 24 Mar 2025 10:30:34 GMT
Content-Type: application/json
Content-Length: 493
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":3,"offset":0,"limit":10,"profiles":[{"id":"db4b7428-e278-4fe3-b85a-d65554d6abe9","group_id":"b9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"profile_name","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}},{"id":"b8073d41-01dc-46ad-bb26-cfecc596c6c1","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"profile_name_1","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}},{"id":"2200527a-f590-4fe5-b9d6-892fc6f825c3","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"profile_name_2","metadata":{"key":"val"},"config":{"Content-Type":"application/json"}}]}

Update Profile#

Update profile entity

Must-have: user_token and profile_id

curl -s -S -i -X PUT -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/profiles/<profile_id> -d '{"name": "<profile_name>"}'

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:32:08 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Access-Control-Expose-Headers: Location

Delete Profile#

Delete a profile entity that is not assigned to any Thing

Must-have: user_token and profile_id

curl -s -S -i -X DELETE -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/profiles/<profile_id>

Response:

HTTP/1.1 204 No Content
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:33:21 GMT
Content-Type: application/json
Connection: keep-alive
Access-Control-Expose-Headers: Location

Search Profiles#

Full-text and field search across all profiles the user can access. Accepts name, metadata, limit, and offset in the request body.

Must-have: user_token

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/profiles/search \
  -d '{"name":"<profile_name>","limit":10,"offset":0}'

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{"total":1,"offset":0,"limit":10,"profiles":[{"id":"db4b7428-e278-4fe3-b85a-d65554d6abe9","name":"profile_name","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a"}]}

Search Profiles by Group#

Search profiles filtered by a specific group.

Must-have: user_token and group_id

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/groups/<group_id>/profiles/search \
  -d '{"name":"<profile_name>","limit":10,"offset":0}'

Search Profiles by Org#

Search profiles filtered by a specific organization.

Must-have: user_token and org_id

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/orgs/<org_id>/profiles/search \
  -d '{"name":"<profile_name>","limit":10,"offset":0}'

Things#

A thing represents a physical or virtual device — a sensor, actuator, gateway, or any connected asset — registered in the platform. Every thing belongs to a group and must be assigned to a profile, which defines its communication schema and behaviour. The key returned at creation is the thing's secret credential, used to authenticate all device-side API calls (messaging, metadata, commands).

Create Things#

One or more things can be created in a single request. Each thing must specify a name, a type, and is implicitly associated with the profile in the URL path.

Valid values for type: device, sensor, actuator, controller, gateway.

Must-have: user_token, profile_id, name, type

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/profiles/<profile_id>/things \
  -d '[{"name":"<thing_name_1>","type":"device"},{"name":"<thing_name_2>","type":"sensor","metadata":{"key":"val"}}]'

Response:

HTTP/1.1 201 Created
Content-Type: application/json

{"things":[{"id":"4328f3e4-4c67-40b3-9491-0ab782c48d50","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_1","type":"device","key":"828c6985-c2d6-419e-a124-ba99147b9920"},{"id":"38aa33fe-39e5-4ee3-97ba-4227cfac63f6","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_2","type":"sensor","key":"f73e7342-06c1-499a-9584-35de495aa338","metadata":{"key":"val"}}]}

Create Things with external ID#

When integrating an existing asset registry (e.g. a device management system or ERP), you can supply your own UUID v4 as the thing ID. This avoids introducing an artificial cross-platform indirection — the same ID used in your external system becomes the thing ID in Mainflux, making the two records directly interchangeable without extra mapping.

Two constraints apply: the ID must be in UUID v4 format, and it must be unique across the Mainflux domain.

Must-have: user_token, profile_id, id, name, type

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/profiles/<profile_id>/things \
  -d '[{"id":"<xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx0001>","name":"<thing_name_1>","type":"device"},{"id":"<xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx0002>","name":"<thing_name_2>","type":"sensor"}]'

Response:

HTTP/1.1 201 Created
Content-Type: application/json

{"things":[{"id":"<xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx0001>","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_1","type":"device","key":"659aa6ca-1781-4a69-9a20-689ddb235506"},{"id":"<xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx0002>","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_2","type":"sensor","key":"840c1ea1-2e8d-4809-a6d3-3433a5c489d2"}]}

Create Things with external key#

An external_key is a freeform, unique identifier you assign from an external system — for example, a serial number, device EUI, or asset tag. It lets external systems authenticate on behalf of a thing using their own identifier rather than the Mainflux-generated internal key. Must be at least 5 characters and unique across the platform.

The external key can be provided at creation time:

Must-have: user_token, profile_id, name, type, external_key

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/profiles/<profile_id>/things \
  -d '[{"name":"<thing_name>","type":"device","external_key":"<external_key>"}]'

It can also be set or replaced on an existing thing:

curl -s -S -i -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/things/<thing_id>/external-key \
  -d '{"key":"<external_key>"}'

And removed when no longer needed:

curl -s -S -i -X DELETE -H "Authorization: Bearer <user_token>" \
  http://localhost/things/<thing_id>/external-key

Once set, the thing can authenticate using its external key:

curl -s -S -i -X POST -H "Content-Type: application/json" \
  http://localhost/identify \
  -d '{"key":"<external_key>","type":"external"}'

View Thing#

You can get thing entity by entering the thing ID and user_token

Must-have: user_token and thing_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/things/<thing_id>

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:20:52 GMT
Content-Type: application/json
Content-Length: 185
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"64140f0b-6448-41cf-967e-1bbcc703c332","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name","key":"659aa6ca-1781-4a69-9a20-689ddb235506","metadata":{"key":"val"}}

View Metadata by Key#

Get thing metadata by providing the thing_key

Must-have: thing_key

curl -s -S -i -X GET -H "Authorization: Thing <thing_key>" http://localhost/metadata

Response:

Server: nginx/1.20.0
Date: Tue, 21 Jan 2025 15:46:10 GMT
Content-Type: application/json
Content-Length: 29
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"metadata":{"test":"data"}}

List Things#

Get all things that the user can access, list requests accepts limit and offset query parameters

Must-have: user_token

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/things

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:21:49 GMT
Content-Type: application/json
Content-Length: 582
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":3,"offset":0,"limit":10,"things":[{"id":"64140f0b-6448-41cf-967e-1bbcc703c332","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name","key":"659aa6ca-1781-4a69-9a20-689ddb235506","metadata":{"key":"val"}},{"id":"4328f3e4-4c67-40b3-9491-0ab782c48d50","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_1","key":"828c6985-c2d6-419e-a124-ba99147b9920"},{"id":"38aa33fe-39e5-4ee3-97ba-4227cfac63f6","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_2","key":"f73e7342-06c1-499a-9584-35de495aa338"}]}

List Things by Group#

Get all things by a certain group

Must-have: user_token, group_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/groups/<group_id>/things

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:21:49 GMT
Content-Type: application/json
Content-Length: 582
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":3,"offset":0,"limit":10,"things":[{"id":"64140f0b-6448-41cf-967e-1bbcc703c332","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name","key":"659aa6ca-1781-4a69-9a20-689ddb235506","metadata":{"key":"val"}},{"id":"4328f3e4-4c67-40b3-9491-0ab782c48d50","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_1","key":"828c6985-c2d6-419e-a124-ba99147b9920"},{"id":"38aa33fe-39e5-4ee3-97ba-4227cfac63f6","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_2","key":"f73e7342-06c1-499a-9584-35de495aa338"}]}

List Things by Profile#

Get all things by a certain profile

Must-have: user_token, profile_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/profiles/<profile_id>/things

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Mon, 24 Mar 2025 15:21:49 GMT
Content-Type: application/json
Content-Length: 582
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":3,"offset":0,"limit":10,"things":[{"id":"64140f0b-6448-41cf-967e-1bbcc703c332","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name","key":"659aa6ca-1781-4a69-9a20-689ddb235506","metadata":{"key":"val"}},{"id":"4328f3e4-4c67-40b3-9491-0ab782c48d50","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_1","key":"828c6985-c2d6-419e-a124-ba99147b9920"},{"id":"38aa33fe-39e5-4ee3-97ba-4227cfac63f6","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_2","key":"f73e7342-06c1-499a-9584-35de495aa338"}]}

List Things by Org#

Get all things by a certain organization

Must-have: user_token, org_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/svcthings/orgs/<org_id>/things

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Mon, 24 Mar 2025 15:21:49 GMT
Content-Type: application/json
Content-Length: 582
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":3,"offset":0,"limit":10,"things":[{"id":"64140f0b-6448-41cf-967e-1bbcc703c332","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name","key":"659aa6ca-1781-4a69-9a20-689ddb235506","metadata":{"key":"val"}},{"id":"4328f3e4-4c67-40b3-9491-0ab782c48d50","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_1","key":"828c6985-c2d6-419e-a124-ba99147b9920"},{"id":"38aa33fe-39e5-4ee3-97ba-4227cfac63f6","group_id":"550e8400-e29b-41d4-a716-446655440000","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","name":"thing_name_2","key":"f73e7342-06c1-499a-9584-35de495aa338"}]}

Update Thing#

Updates a thing's name, type, key, or metadata. To reassign a thing to a different profile or group, use the Update Thing Group and Profile endpoint instead.

Must-have: user_token, thing_id, name, key, type

curl -s -S -i -X PUT -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/things/<thing_id> -d '{"name": "<thing_name>","key":"<thing_key>","type":"device"}'

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:23:36 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Access-Control-Expose-Headers: Location

Update Thing Group and Profile#

Reassigns a thing to a different profile and/or group. The profile must belong to the target group.

Must-have: user_token, thing_id, profile_id, group_id

curl -s -S -i -X PATCH -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/things/<thing_id> -d '{"profile_id":"<profile_id>","group_id":"<group_id>"}'

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:23:36 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Access-Control-Expose-Headers: Location

Update Things Metadata#

Updating a things metadata

Must-have: user_token

curl -s -S -i -X PUT -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/things -d '[{"id":"64140f0b-6448-41cf-967e-1bbcc703c332","metadata":{"new_key1":"new_val1"}},{"id":"4328f3e4-4c67-40b3-9491-0ab782c48d50","metadata":{"new_key2":"new_val2"}}]'

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Mon, 24 Mar 2025 16:00:00 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Access-Control-Expose-Headers: Location

Delete Thing#

To delete a thing you need a thing_id and a user_token

Must-have: user_token and thing_id

curl -s -S -i -X DELETE -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/things/<thing_id>

Response:

HTTP/1.1 204 No Content
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 15:24:44 GMT
Content-Type: application/json
Connection: keep-alive
Access-Control-Expose-Headers: Location

Identify#

Validates a thing's key and returns its ID. The type field must be internal or external, depending on which key type is being submitted.

Must-have: thing_key, type

curl -s -S -i -X POST -H "Content-Type: application/json" http://localhost/identify -d '{"key": "<thing_key>", "type": "internal"}'

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Mon, 22 Mar 2021 15:04:41 GMT
Content-Type: application/json
Content-Length: 46
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"d69d0098-072b-41bf-8c6e-ce4dbb12d333"}

Get Group by Thing#

Returns the group a thing belongs to.

Must-have: user_token and thing_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/things/<thing_id>/groups

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{"id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","name":"group_name","org_id":"...","description":"...","metadata":{},"created_at":"...","updated_at":"..."}

Search Things#

Full-text and field search across all things the user can access. Accepts name, metadata, limit, and offset in the request body.

Must-have: user_token

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/things/search \
  -d '{"name":"<thing_name>","limit":10,"offset":0}'

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{"total":1,"offset":0,"limit":10,"things":[{"id":"4328f3e4-4c67-40b3-9491-0ab782c48d50","name":"thing_name","key":"828c6985-c2d6-419e-a124-ba99147b9920","group_id":"c9bf9e57-1685-4c89-bafb-ff5af830be8a","profile_id":"a9bf9e57-1685-4c89-bafb-ff5af830be8b","type":"device"}]}

Search Things by Profile#

Search things filtered by a specific profile.

Must-have: user_token and profile_id

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/profiles/<profile_id>/things/search \
  -d '{"name":"<thing_name>","limit":10,"offset":0}'

Search Things by Group#

Search things filtered by a specific group.

Must-have: user_token and group_id

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/groups/<group_id>/things/search \
  -d '{"name":"<thing_name>","limit":10,"offset":0}'

Search Things by Org#

Search things filtered by a specific organization.

Must-have: user_token and org_id

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/orgs/<org_id>/things/search \
  -d '{"name":"<thing_name>","limit":10,"offset":0}'

Messages#

Send Messages#

Sends message via HTTP protocol

Must-have: thing_key

For SenML:

curl -s -S -i -X POST -H "Authorization: Thing <thing_key>" -H "Content-Type: application/json" "http://localhost/http/messages" -d '[{"bn":"some-base-name:","bt":1.276020076001e+09,"bu":"A","bver":5,"n":"voltage","u":"V","v":120.1}, {"n":"current","t":-5,"v":1.2}, {"n":"current","t":-4,"v":1.3}]'

For JSON:

curl -X POST -H "Authorization: Thing <thing_key>" -H "Content-Type: application/json" "http://localhost/http/messages" -d '[{ "name": "temperature", "value": 20.5, "unit": "°C"}, {"name": "humidity", "value": 68, "unit": "%"}]'

Response:

HTTP/1.1 202 Accepted
Server: nginx/1.16.0
Date: Wed, 10 Mar 2021 16:53:54 GMT
Content-Length: 0
Connection: keep-alive

Read Messages#

Reads messages from database with optional filtering and pagination.

Must-have: user_token and format.

For SenML:

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" "http://localhost/reader/senml"

For JSON:

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" "http://localhost/reader/json"

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Wed, 10 Mar 2021 16:54:58 GMT
Content-Length: 660

{"offset":0,"limit":10,"format":"messages","total":3,"messages":[{"publisher":"33eb28c3-4ca2-45c3-b1c5-d5d049c6c24e","protocol":"http","name":"some-base-name:voltage","unit":"V","time":1276020076.001,"value":120.1},{"publisher":"33eb28c3-4ca2-45c3-b1c5-d5d049c6c24e","protocol":"http","name":"some-base-name:current","unit":"A","time":1276020072.001,"value":1.3},{"publisher":"33eb28c3-4ca2-45c3-b1c5-d5d049c6c24e","protocol":"http","name":"some-base-name:current","unit":"A","time":1276020071.001,"value":1.2}]}

Delete All Messages#

Deletes all messages for the authenticated thing, with an optional time range filter.

Must-have: user_token

For SenML:

curl -X DELETE -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" "http://localhost/reader/senml?from=<start_timestamp>&to=<end_timestamp>"

For JSON:

curl -X DELETE -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" "http://localhost/reader/json?from=<start_timestamp>&to=<end_timestamp>"

Response:

HTTP/1.1 204 No Content

Delete Messages by Publisher#

Deletes messages from a specific publisher, with an optional time range filter.

Must-have: user_token, publisher_id

For SenML:

curl -X DELETE -H "Authorization: Bearer <user_token>" "http://localhost/reader/senml/<publisher_id>?from=<start_timestamp>&to=<end_timestamp>"

For JSON:

curl -X DELETE -H "Authorization: Bearer <user_token>" "http://localhost/reader/json/<publisher_id>?from=<start_timestamp>&to=<end_timestamp>"

Response:

HTTP/1.1 204 No Content

Note: <start_timestamp> and <end_timestamp> are int values in nanoseconds. Currently supported formats are json and senml.

Backup Messages#

Exports a full backup of all stored messages as a single file (format-agnostic).

Must-have: user_token

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" "http://localhost/reader/backup" -o "backup.json"

Export Messages#

Exports messages in a specific format, optionally converting to CSV.

Must-have: user_token

For SenML:

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" "http://localhost/reader/senml/export?convert=<file_type>" -o "<file_name>.<file_type>"

For JSON:

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" "http://localhost/reader/json/export?convert=<file_type>" -o "<file_name>.<file_type>"

Note: You can use csv or json for file_type. If ?convert is omitted, the response is returned as JSON.

Restore Messages#

Restores messages from a backup file. Requires Content-Type: application/octet-stream.

Must-have: user_token, file_name

curl -X POST -H "Authorization: Bearer <user_token>" -H "Content-Type: application/octet-stream" "http://localhost/reader/restore" --data-binary @<file_name>

Search Messages#

Searches messages with field-level filtering. Accepts publisher, protocol, name, from, to, limit, and offset.

Must-have: user_token

For SenML:

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  "http://localhost/reader/senml/search" \
  -d '{"publisher":"<publisher_id>","from":<start_timestamp>,"to":<end_timestamp>,"limit":10,"offset":0}'

For JSON:

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  "http://localhost/reader/json/search" \
  -d '{"publisher":"<publisher_id>","from":<start_timestamp>,"to":<end_timestamp>,"limit":10,"offset":0}'

API Key#

Issue API Key#

Generates a new API key. Then new API key will be uniquely identified by its ID. Duration is expressed in seconds.

Must-have: user_token

curl -isSX POST  http://localhost/keys -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" -d '{"type":2, "duration":10000}'

Response:

HTTP/1.1 201 Created
Server: nginx/1.20.0
Date: Sun, 19 Dec 2021 17:39:44 GMT
Content-Type: application/json
Content-Length: 476
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"4d62fb1e-085e-435c-a0c5-5255febfa35b","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NDAwMzU1ODQsImp0aSI6IjRkNjJmYjFlLTA4NWUtNDM1Yy1hMGM1LTUyNTVmZWJmYTM1YiIsImlhdCI6MTYzOTkzNTU4NCwiaXNzIjoibWFpbmZsdXguYXV0aCIsInN1YiI6ImZscDFAZW1haWwuY29tIiwiaXNzdWVyX2lkIjoiYzkzY2FmYjMtYjNhNy00ZTdmLWE0NzAtMTVjMTRkOGVkMWUwIiwidHlwZSI6Mn0.RnvjhygEPPWFDEUKtfk5okzVhZzOcO0azr8gd5vby5M","issued_at":"2021-12-19T17:39:44.175088349Z","expires_at":"2021-12-20T21:26:24.175088349Z"}

View API key details#

Must-have: 'user_token' and 'key_id'

curl -isSX GET  http://localhost/keys/<key_id> -H 'Content-Type: application/json' -H 'Authorization: Bearer <user_token>'

Response:

HTTP/1.1 200 OK
Server: nginx/1.20.0
Date: Sun, 19 Dec 2021 17:43:30 GMT
Content-Type: application/json
Content-Length: 218
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"f630f594-d967-4c54-85ef-af58efe8e8ed","issuer_id":"c93cafb3-b3a7-4e7f-a470-15c14d8ed1e0","subject":"test@email.com","type":2,"issued_at":"2021-12-19T17:42:40.884521Z","expires_at":"2021-12-20T21:29:20.884521Z"}

List API Keys#

Returns a paginated list of API keys issued by the authenticated user.

Must-have: user_token

curl -isSX GET http://localhost/keys -H 'Authorization: Bearer <user_token>'

Response:

HTTP/1.1 200 OK
Server: nginx/1.20.0
Date: Sun, 19 Dec 2021 17:50:00 GMT
Content-Type: application/json
Content-Length: 320
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":1,"offset":0,"limit":10,"keys":[{"id":"f630f594-d967-4c54-85ef-af58efe8e8ed","issuer_id":"c93cafb3-b3a7-4e7f-a470-15c14d8ed1e0","subject":"test@email.com","type":2,"issued_at":"2021-12-19T17:42:40.884521Z","expires_at":"2021-12-20T21:29:20.884521Z"}]}

Revoke API Key#

Must-have: user_token and key_id

curl -isSX DELETE  http://localhost/keys/<key_id> -H 'Content-Type: application/json' -H 'Authorization: Bearer <user_token>'

Response:

HTTP/1.1 204 No Content
Server: nginx/1.20.0
Date: Sun, 19 Dec 2021 17:47:11 GMT
Content-Type: application/json
Connection: keep-alive
Access-Control-Expose-Headers: Location

Org Invites#

Org Invites allow organization administrators to invite registered users to join an organization. An invitation is delivered via email and must be explicitly accepted or declined by the recipient.

Create Org Invite#

Creates an invitation for a registered user to join the specified organization with a given role. An optional list of groups and roles can be included; the invitee will be automatically added to those groups upon acceptance.

Must-have: user_token, org_id, email, role

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" http://localhost/orgs/<org_id>/invites -d '{"email":"<invitee_email>","role":"editor","redirect_path":"/invite-view"}'

Response:

HTTP/1.1 201 Created
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:03:14 GMT
Content-Length: 0

List Org Invites#

Returns a paginated list of invitations for the specified organization.

Must-have: user_token, org_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/orgs/<org_id>/invites

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:05:00 GMT
Content-Length: 350

{"total":1,"offset":0,"limit":10,"invites":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","invitee_email":"<invitee_email>","inviter_id":"a08bd22c-916d-4ed1-8ca4-8d32ede58822","inviter_email":"admin@example.com","org_id":"25da5d7a-d3f5-435e-bcad-0cf22343121a","org_name":"my_org","invitee_role":"editor","state":"pending","created_at":"2023-07-14T14:03:14.897Z","expires_at":"2023-07-21T14:03:14.897Z"}]}

View Org Invite#

Returns the details of a specific invitation.

Must-have: user_token, invite_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/svcauth/invites/<invite_id>

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:06:00 GMT
Content-Length: 310

{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","invitee_email":"<invitee_email>","inviter_id":"a08bd22c-916d-4ed1-8ca4-8d32ede58822","inviter_email":"admin@example.com","org_id":"25da5d7a-d3f5-435e-bcad-0cf22343121a","org_name":"my_org","invitee_role":"editor","state":"pending","created_at":"2023-07-14T14:03:14.897Z","expires_at":"2023-07-21T14:03:14.897Z"}

Accept Org Invite#

The invitee accepts the invitation. Upon acceptance, the invitee is added to the organization (and any groups specified in the invite) with the assigned role.

Must-have: user_token (of the invitee), invite_id

curl -s -S -i -X POST -H "Authorization: Bearer <user_token>" http://localhost/svcauth/invites/<invite_id>/accept

Response:

HTTP/1.1 201 Created
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:10:00 GMT
Content-Length: 0

Decline Org Invite#

The invitee declines the invitation.

Must-have: user_token (of the invitee), invite_id

curl -s -S -i -X POST -H "Authorization: Bearer <user_token>" http://localhost/svcauth/invites/<invite_id>/decline

Response:

HTTP/1.1 204 No Content
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:11:00 GMT

Revoke Org Invite#

The inviter cancels a pending invitation. Only the user who created the invite can revoke it.

Must-have: user_token (of the inviter), invite_id

curl -s -S -i -X DELETE -H "Authorization: Bearer <user_token>" http://localhost/svcauth/invites/<invite_id>

Response:

HTTP/1.1 204 No Content
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:12:00 GMT

List Invites Received by User#

Returns a paginated list of invitations received by the specified user (as invitee).

Must-have: user_token, user_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/svcauth/users/<user_id>/invites/received

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:13:00 GMT
Content-Length: 350

{"total":1,"offset":0,"limit":10,"invites":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","invitee_email":"<invitee_email>","inviter_email":"admin@example.com","org_id":"25da5d7a-d3f5-435e-bcad-0cf22343121a","org_name":"my_org","invitee_role":"editor","state":"pending","created_at":"2023-07-14T14:03:14.897Z","expires_at":"2023-07-21T14:03:14.897Z"}]}

List Invites Sent by User#

Returns a paginated list of invitations sent by the specified user (as inviter).

Must-have: user_token, user_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/svcauth/users/<user_id>/invites/sent

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 14 Jul 2023 14:14:00 GMT
Content-Length: 350

{"total":1,"offset":0,"limit":10,"invites":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","invitee_email":"<invitee_email>","inviter_email":"admin@example.com","org_id":"25da5d7a-d3f5-435e-bcad-0cf22343121a","org_name":"my_org","invitee_role":"editor","state":"pending","created_at":"2023-07-14T14:03:14.897Z","expires_at":"2023-07-21T14:03:14.897Z"}]}

Platform Invites#

Platform Invites allow administrators to invite unregistered users to the platform, optionally pre-assigning them to an organization and groups. Unlike Org Invites (which target already-registered users), Platform Invites are for onboarding new users.

Create Platform Invite#

Must-have: user_token, invitee_email

curl -s -S -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <user_token>" \
  http://localhost/svcauth/invites \
  -d '{"invitee_email":"<invitee_email>","org_id":"<org_id>","role":"editor","group_invites":[{"group_id":"<group_id>","member_role":"viewer"}]}'

Response:

HTTP/1.1 201 Created
Content-Type: application/json
Location: /invites/a1b2c3d4-e5f6-7890-abcd-ef1234567890

List Platform Invites#

Must-have: user_token

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" http://localhost/svcauth/invites

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{"total":1,"offset":0,"limit":10,"invites":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","invitee_email":"<invitee_email>","state":"pending","created_at":"2023-07-14T14:03:14.897Z","expires_at":"2023-07-21T14:03:14.897Z"}]}

Register via Platform Invite#

Completes registration for a user who received a Platform Invite. The submitted email must match the invite.

Must-have: invite_id, email, password

curl -s -S -i -X POST -H "Content-Type: application/json" \
  http://localhost/register/invite/<invite_id> \
  -d '{"email":"<invitee_email>","password":"<password>"}'

Response:

HTTP/1.1 201 Created

Webhooks#

Create Webhooks#

To forward a message to another platform, you need to create a Webhook with the necessary data such as the name of the Webhook, thing_id which refers to the Thing for which the Webhook is being created, the url to which the message will be forwarded and HTTP headers specific for the certain webhook.

You can create multiple Webhooks at once by entering a series of Webhooks structures, thing_id and a user_token.

Must-have: user_token, thing_id, name and url

curl -s -S -i -X POST -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" http://localhost/svcwebhooks/things/<thing_id>/webhooks -d '{"webhooks: [{"name":"webhook_name","url":"https://webhook.com","headers":{"Content-Type":"application/json"}}]}'

Response:

HTTP/1.1 201 Created
Server: nginx/1.20.0
Date: Thu, 11 Apr 2024 11:47:12 GMT
Content-Type: application/json
Content-Length: 191
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"f630f594-d967-4c54-85ef-af58efe8e8ed","thing_id":"64140f0b-6448-41cf-967e-1bbcc703c332","group_id":"c93cafb3-b3a7-4e7f-a470-15c14d8ed1e0","name":"webhook_name","url":"https://webhook.com","headers":{"Content-Type":"application/json"}}

List Webhooks by Group#

You can get all Webhooks for certain Group by entering user_token and group_id.

Must-have: user_token and group_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" http://localhost/svcwebhooks/groups/<group_id>/webhooks

Response:

HTTP/1.1 200 OK
Server: nginx/1.20.0
Date: Thu, 11 Apr 2024 11:44:57 GMT
Content-Type: application/json
Content-Length: 488
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":3,"offset":0,"limit":10,"webhooks":[{"id":"f630f594-d967-4c54-85ef-af58efe8e8ed","thing_id":"64140f0b-6448-41cf-967e-1bbcc703c332","group_id":"50e6b371-60ff-45cf-bb52-8200e7cde536","name":"Test","url":"https://api.test.com/","headers":{"Content-Type":"application/json"}},{"id":"1234f594-d967-4c54-85ef-af58efe8e8ed","thing_id":"12140f0b-6448-41cf-967e-1bbcc703c332","group_id":"50e6b371-60ff-45cf-bb52-8200e7cde536","name":"Test2","url":"https://api.test2.com/","headers":{}}]}

List Webhooks by Thing#

You can get all Webhooks for certain Thing by entering user_token and thing_id.

Must-have: user_token and thing_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" http://localhost/svcwebhooks/things/<thing_id>/webhooks

Response:

HTTP/1.1 200 OK
Server: nginx/1.20.0
Date: Mon, 24 Mar 2025 11:44:57 GMT
Content-Type: application/json
Content-Length: 250
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":1,"offset":0,"limit":10,"webhooks":[{"id":"f630f594-d967-4c54-85ef-af58efe8e8ed","thing_id":"64140f0b-6448-41cf-967e-1bbcc703c332","group_id":"50e6b371-60ff-45cf-bb52-8200e7cde536","name":"Test","url":"https://api.test.com/","headers":{"Content-Type":"application/json"}}]}

View Webhook#

View details of a certain Webhook by entering user_token and webhook_id.

Must-have: user_token and group_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" http://localhost/webhooks/<webhook_id>

Response:

HTTP/1.1 200 OK
Server: nginx/1.20.0
Date: Thu, 11 Apr 2024 11:44:57 GMT
Content-Type: application/json
Content-Length: 185
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"f630f594-d967-4c54-85ef-af58efe8e8ed","thing_id":"64140f0b-6448-41cf-967e-1bbcc703c332","group_id":"50e6b371-60ff-45cf-bb52-8200e7cde536","name":"Test","url":"https://api.test.com/","headers":{"Content-Type":"application/json"}}

Update Webhook#

Update data of webhook with provided ID and user_token

Must-have: user_token and webhook_id

curl -s -S -i -X PUT -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/webhooks/<webhook_id> -d '{"name": "<webhook_name>"}'

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Thu, 11 Apr 2024 11:54:52 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Access-Control-Expose-Headers: Location

Delete Webhooks#

Delete webhooks by given IDs

Must-have: user_token, webhook_ids

curl -s -S -i -X PATCH -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/webhooks -d '{"webhook_ids":["c93cafb3-b3a7-4e7f-a470-15c14d8ed1e0","2513d843-abf8-4db4-93fd-bdc8917d42mm"]}'

Response:

HTTP/1.1 204 No Content
Server: nginx/1.16.0
Date: Thu, 11 Apr 2024 11:55:10 GMT
Content-Type: application/json
Connection: keep-alive
Access-Control-Expose-Headers: Location

Notifiers#

Create Notifiers#

In order to send email notifications to certain contacts when a message arrives, you need to create a Notifier with the necessary data, such as the Notifier's name, group_id, which refers to the Group for which the Notifier is being created, the contacts to which the notifications will be sent and optional metadata.

You can create multiple Notifiers at once by entering a series of Notifiers structures, group_id and a user_token.

Must-have: user_token, group_id, name and contacts

curl -s -S -i -X POST -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" http://localhost/svcsmtp/groups/<group_id>/notifiers -d '{"notifiers: [{"name":"notifier_name","contacts": ["email1@example.com", "email2@example.com"],"metadata":{}}]}'

Response:

HTTP/1.1 201 Created
Server: nginx/1.20.0
Date: Thu, 11 Apr 2024 12:17:12 GMT
Content-Type: application/json
Content-Length: 190
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"a630f594-d967-4c54-85ef-af58efe8e8eb","group_id":"c93cafb3-b3a7-4e7f-a470-15c14d8ed1e0","name":"notifier_name","contacts": ["email1@example.com", "email2@example.com"],"metadata":{}}

Note: The logged-in user who creates a Notifier for a certain Group must have the role of "editor" of that Group.

List Notifiers by Group#

You can get all Notifiers for certain Group by entering user_token and group_id.

Must-have: user_token and group_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" http://localhost/svcsmtp/groups/<group_id>/notifiers

Response:

HTTP/1.1 200 OK
Server: nginx/1.20.0
Date: Thu, 11 Apr 2024 12:19:57 GMT
Content-Type: application/json
Content-Length: 337
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"total":2,"offset":0,"limit":10,"notifiers":[{"id":"a630f594-d967-4c54-85ef-af58efe8e8eb","group_id":"50e6b371-60ff-45cf-bb52-8200e7cde536","name":"Test","contacts": ["test1@example.com"]},{"id":"2234f594-d967-4c54-85ef-af58efe8e8ed","group_id":"50e6b371-60ff-45cf-bb52-8200e7cde536","name":"Test2","contacts": ["test2@example.com"]}]}

View Notifier#

View details of a certain Notifier by entering user_token and notifier_id.

Must-have: user_token and group_id

curl -s -S -i -X GET -H "Authorization: Bearer <user_token>" -H "Content-Type: application/json" http://localhost/svcsmtp/notifiers/<notifier_id>

Response:

HTTP/1.1 200 OK
Server: nginx/1.20.0
Date: Thu, 11 Apr 2024 12:24:57 GMT
Content-Type: application/json
Content-Length: 145
Connection: keep-alive
Access-Control-Expose-Headers: Location

{"id":"a630f594-d967-4c54-85ef-af58efe8e8eb","group_id":"50e6b371-60ff-45cf-bb52-8200e7cde536","name":"Test","contacts": ["test1@example.com"]}}

Update Notifier#

Update data of notifier with provided ID and user_token

Must-have: user_token and notifier_id

curl -s -S -i -X PUT -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/svcsmtp/notifiers/<notifier_id> -d '{"name": "<new_notifier_name>"}'

Response:

HTTP/1.1 200 OK
Server: nginx/1.16.0
Date: Thu, 11 Apr 2024 12:34:52 GMT
Content-Type: application/json
Content-Length: 0
Connection: keep-alive
Access-Control-Expose-Headers: Location

Delete Notifiers#

Delete notifiers by given IDs

Must-have: user_token,group_id, notifier_ids

curl -s -S -i -X PATCH -H "Content-Type: application/json" -H  "Authorization: Bearer <user_token>" http://localhost/svcsmtp/notifiers -d '{"notifier_ids":["a93cafb3-b3a7-4e7f-a470-15c14d8ed1e1","b513d843-abf8-4db4-93fd-bdc8917d42m2"]}'

Response:

HTTP/1.1 204 No Content
Server: nginx/1.16.0
Date: Thu, 11 Apr 2024 12:55:10 GMT
Content-Type: application/json
Connection: keep-alive
Access-Control-Expose-Headers: Location