REST API overview

REST API overview

User Management

See also: Managing Users

Create a user

See also: Signing up

/api/apps/{appID}/users
POST
Create a new user in the current application.

Create a user and obtain the access token

See also: Pseudo Users

/api/apps/{appID}/users
POST
Creating a new user in the current application and obtain an access token of the user. This API is for supporting a pseudo user (i.e. a user without username and password).

Delete a user

See also: Deleting a User

/api/apps/{appID}/users/{accountType}:{address}
DELETE
By address

/api/apps/{appID}/users/me
DELETE
By "me" literal

Manipulate user data

See also: User Attributes, Retrieving Other User's Data

Retrieve user data

/api/apps/{appID}/users/{accountType}:{address}
GET
By address

/api/apps/{appID}/users/me
GET
By "me" literal

Modify user data

/api/apps/{appID}/users/{accountType}:{address}
POST
By address

/api/apps/{appID}/users/me
POST
By "me" literal

Get the country

/api/apps/{appID}/users/{accountType}:{address}/country
GET
By address

/api/apps/{appID}/users/{userID}/country
GET
By ID

Get the display name

/api/apps/{appID}/users/{accountType}:{address}/display-name
GET
By address

/api/apps/{appID}/users/{userID}/display-name
GET
By ID

Get the locale

/api/apps/{appID}/users/{accountType}:{address}/locale
GET
By address

/api/apps/{appID}/users/me/locale
GET
By "me" literal

Manipulate the email address

Get the email address

/api/apps/{appID}/users/{accountType}:{address}/email-address
GET
By address

/api/apps/{appID}/users/{userID}/email-address
GET
By ID

/api/apps/{appID}/users/me/email-address
GET
By "me" literal

Update the email address

/api/apps/{appID}/users/{accountType}:{address}/email-address
PUT
By address

/api/apps/{appID}/users/{userID}/email-address
PUT
By ID

/api/apps/{appID}/users/me/email-address
PUT
By "me" literal

Remove the email address

/api/apps/{appID}/users/{accountType}:{address}/email-address
DELETE
By address

/api/apps/{appID}/users/{userID}/email-address
DELETE
By ID

/api/apps/{appID}/users/me/email-address
DELETE
By "me" literal

Manipulate the phone number

Get the phone number

/api/apps/{appID}/users/{accountType}:{address}/phone-number
GET
By address

/api/apps/{appID}/users/{userID}/phone-number
GET
By ID

Update the phone number

/api/apps/{appID}/users/{accountType}:{address}/phone-number
PUT
By address

/api/apps/{appID}/users/{userID}/phone-number
PUT
By ID

Remove the phone number

/api/apps/{appID}/users/{accountType}:{address}/phone-number
DELETE
By address

/api/apps/{appID}/users/{userID}/phone-number
DELETE
By ID

Manage user verification

See also: Signing up

Manage email address verification

Resend the verification email

/api/apps/{appID}/users/{accountType}:{address}/email-address/resend-verification
POST
By address

/api/apps/{appID}/users/{userID}/email-address/resend-verification
POST
By ID

/api/apps/{appID}/users/me/email-address/resend-verification
POST
By "me" literal

Get the verification code

/api/apps/{appID}/users/{accountType}:{address}/email-address/verification-code
GET
By address

/api/apps/{appID}/users/{userID}/email-address/verification-code
GET
By ID

/api/apps/{appID}/users/me/email-address/verification-code
GET
By "me" literal

Verify the email address

/api/apps/{appID}/users/{accountType}:{address}/email-address/verify
POST
By address

/api/apps/{appID}/users/{userID}/email-address/verify
POST
By ID

/api/apps/{appID}/users/me/email-address/verify
POST
By "me" literal

Manage phone number verification

Resend the SMS with the verification code

/api/apps/{appID}/users/{accountType}:{address}/phone-number/resend-verification
POST
By address

/api/apps/{appID}/users/{userID}/phone-number/resend-verification
POST
By ID

/api/apps/{appID}/users/me/phone-number/resend-verification
POST
By "me" literal

Reset the verification code

/api/apps/{appID}/users/{accountType}:{address}/phone-number/reset-verification-code
POST
By address

/api/apps/{appID}/users/{userID}/phone-number/reset-verification-code
POST
By ID

/api/apps/{appID}/users/me/phone-number/reset-verification-code
POST
By "me" literal

Get the verification code

/api/apps/{appID}/users/{accountType}:{address}/phone-number/verification-code
GET
By address

/api/apps/{appID}/users/{userID}/phone-number/verification-code
GET
By ID

/api/apps/{appID}/users/me/phone-number/verification-code
GET
By "me" literal

Verify the phone number

/api/apps/{appID}/users/{accountType}:{address}/phone-number/verify
POST
By address

/api/apps/{appID}/users/{userID}/phone-number/verify
POST
By ID

/api/apps/{appID}/users/me/phone-number/verify
POST
By "me" literal

Manage OAuth2 credentials

See also: Logging in

Request a new token

/api/apps/{appID}/oauth2/token
POST
Request a new token.

Manage password

See also: Changing the User Password, Resetting the User Password

Change the password

/api/apps/{appID}/users/{accountType}:{address}/password
PUT
By address

/api/apps/{appID}/users/{userID}/password
PUT
By ID

Request for password reset with an email

/api/apps/{appID}/users/{accountType}:{address}/password/request-reset
POST
By address

/api/apps/{appID}/users/{accountType}:{address}/password/reset
POST
By address

/api/apps/{appID}/users/{userID}/password/request-reset
POST
By ID

/api/apps/{appID}/users/{userID}/password/reset
POST
By ID

/api/apps/{appID}/users/me/password/request-reset
POST
By "me" literal

/api/apps/{appID}/users/me/password/reset
POST
By "me" literal

Request for password reset with a chosen notification method

/api/apps/{appID}/users/{accountType}:{address}/password/request-reset
POST
By address

/api/apps/{appID}/users/{userID}/password/request-reset
POST
By ID

/api/apps/{appID}/users/me/password/request-reset
POST
By "me" literal

Complete the password reset by sending a PIN code

/api/apps/{appID}/users/{accountType}:{address}/password/complete-reset
POST
By address

/api/apps/{appID}/users/{userID}/password/complete-reset
POST
By ID

/api/apps/{appID}/users/me/password/complete-reset
POST
By "me" literal

Manage user status

See also: Disabling Users

Get the user status

/api/apps/{appID}/users/{accountType}:{address}/status
GET
By address

/api/apps/{appID}/users/me/status
GET
By "me" literal

Change the user status

/api/apps/{appID}/users/{accountType}:{address}/status
PUT
By address

/api/apps/{appID}/users/me/status
PUT
By "me" literal

Group Management

See also: Managing Groups

Create a group

/api/apps/{appID}/groups
POST
Create a new group.

Create a group with a given groupID

/api/apps/{appID}/groups/{groupID}
PUT
Create a new group with a given groupID.

Get the group information

/api/apps/{appID}/groups/{groupID}
GET
Get the data of the group.

Delete a group

/api/apps/{appID}/groups/{groupID}
DELETE
Delete the group.

Get a list of groups filtered by a user

/api/apps/{appID}/groups
GET
Get a list of groups.

Update a group name

/api/apps/{appID}/groups/{groupID}/name
PUT
Update the group name.

Update a group owner

/api/apps/{appID}/groups/{groupID}/owner
PUT
Change the group owner.

Manage group members

See also: Adding and Removing a Member, Getting a Member List of a Group

Add a member

/api/apps/{appID}/groups/{groupID}/members/{userID}
PUT
Add a new group member.

Remove a member

/api/apps/{appID}/groups/{groupID}/members/{userID}
DELETE
Remove a group member.

Get a list of group members

/api/apps/{appID}/groups/{groupID}/members
GET
Get the collection of group members.

Thing Management

See also: Tuning with Kii Cloud SDK for Thing, Thing Management

Register a thing

/api/apps/{appID}/things
POST
Register a new thing in the current application.

Register a thing and obtain access token

/api/apps/{appID}/things
POST
Register a new thing and obtain an access token in the current application.

Check if the thing is registered

/api/apps/{appID}/things/{thingID}
HEAD
Check if the thing is already registered.

Get the thing information

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}
GET
By vendor ID

Update the thing information

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}
PATCH
By vendor ID

Unregister a thing

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}
DELETE
By vendor ID

Query for things

/api/apps/{appID}/things/query
POST
Retrieve a list of things that match with a criteria.

Manage OAuth2 credentials

Request a new token

/api/apps/{appID}/oauth2/token
POST
Request a new token.

Manage thing status (enable/disable)

Get the thing status

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/status
GET
By vendor ID

/api/apps/{appID}/things/{thingID}/status
GET
By ID

Change the thing status (enable/disable)

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/status
PUT
By vendor ID

/api/apps/{appID}/things/{thingID}/status
PUT
By ID

Manage thing ownership

See also: Ownership Management

Add new ownership

Password flow (add the ownership with a thing password)

Add a user or group as the owner

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership
POST
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership
POST
By ID

Verification flow (add the ownership with a code validation)

Start the verification flow for adding a user as the owner

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/request/user:{userID}
POST
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership/request/user:{userID}
POST
By ID

Start the verification flow for adding a group as the owner

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/request/group:{groupID}
POST
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership/request/group:{groupID}
POST
By ID

Complete the verification flow by validating the code

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/confirm
POST
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership/confirm
POST
By ID

(Old) simple flow (add the ownership without any validation)

Add a user as the owner

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/user:{userID}
PUT
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership/user:{userID}
PUT
By ID

Add a group as the owner

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/group:{groupID}
PUT
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership/group:{groupID}
PUT
By ID

Verify ownership

Verify if a user is an owner

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/user:{userID}
HEAD
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership/user:{userID}
HEAD
By ID

Verify if a group is an owner

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/group:{groupID}
HEAD
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership/group:{groupID}
HEAD
By ID

Remove ownership

Remove a user from the owner

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/user:{userID}
DELETE
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership/user:{userID}
DELETE
By ID

Remove a group from the owner

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/group:{groupID}
DELETE
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership/group:{groupID}
DELETE
By ID

Retrieve all thing owners

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership
GET
By vendor ID

/api/apps/{appID}/things/{thingID}/ownership
GET
By ID

Data Management

See also: Managing Data

Manage Buckets

Application Scope

Retrieve the bucket information

/api/apps/{appID}/buckets/{bucketID}
GET
Retrieve a bucket information.

Verify the bucket existence

/api/apps/{appID}/buckets/{bucketID}
HEAD
Verify if a bucket exists

Delete a bucket

/api/apps/{appID}/buckets/{bucketID}
DELETE
Delete a bucket and its content.

Group Scope

Retrieve the bucket information

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}
GET
Retrieve a bucket information.

Verify the bucket existence

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}
HEAD
Verify if a bucket exists

Delete a bucket

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}
DELETE
Delete a bucket and its content.

User Scope

Retrieve the bucket information

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}
GET
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}
GET
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}
GET
By "me" literal

Verify the bucket existence

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}
HEAD
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}
HEAD
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}
HEAD
By "me" literal

Delete a bucket

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}
DELETE
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}
DELETE
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}
DELETE
By "me" literal

Thing Scope

Retrieve the bucket information

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}
GET
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}
GET
By ID

Verify the bucket existence

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}
HEAD
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}
HEAD
By ID

Delete a bucket

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}
DELETE
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}
DELETE
By ID

Manage Objects

Application Scope

Create an object

/api/apps/{appID}/buckets/{bucketID}/objects
POST
Create a new object in the bucket.

Retrieve an object

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}
GET
Retrieve the object.

Fully update an object / Create a new object with an ID

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}
PUT
Replace an existing object or create a new object with the specified ID.

Partially update an object

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}
PATCH
Update the object partially.

Delete an object

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}
DELETE
Delete the object.

Check the object existence

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}
HEAD
Verify if the object exists.

Query for objects

/api/apps/{appID}/buckets/{bucketID}/query
POST
Query the bucket and retrieve the objects that match with the specified conditions.

Retrieve an object body

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body
GET
Retrieve the object body.

Add or replace an object body

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body
PUT
Add or replace the object body.

Verify the object body existence

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body
HEAD
Verify if the object has a body.

Delete an object body

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body
DELETE
Delete the object body.

Move an object body

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body/move
POST
Move the object body.

Publish an object body

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body/publish
POST
Publish the object body and get its URL.

Start uploading an object body

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body/uploads
POST
Start uploading the object body.

Get the upload metadata

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}
HEAD
Get the upload metadata.

Upload the given object data

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/data
PUT
Upload the object data.

Set the object body upload status to committed

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/status/committed
POST
Set the status of the object body upload to "committed"

Set the object body upload status to cancelled

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/status/cancelled
POST
Set the status of the object body to "cancelled"

Group Scope

Create an object

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects
POST
Create a new object in the bucket.

Retrieve an object

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}
GET
Retrieve the object.

Fully update an object / Create a new object with an ID

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}
PUT
Replace an existing object or create a new object with the specified ID.

Partially update an object

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}
PATCH
Update the object partially.

Delete an object

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}
DELETE
Delete the object.

Check an object existence

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}
HEAD
Verify if the object exists.

Query for objects

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/query
POST
Query the bucket and retrieve the objects that match with the specified conditions.

Retrieve an object body

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body
GET
Retrieve the object body.

Add or replace an object body

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body
PUT
Add or replace the object body.

Verify an object body existence

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body
HEAD
Verify if the object has a body.

Delete an object body

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body
DELETE
Delete the object body.

Move an object body

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body/move
POST
Move the object body.

Publish an object body

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body/publish
POST
Publish the object body and get its URL.

Start uploading an object body

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body/uploads
POST
Start uploading the object body.

Get the upload metadata

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}
HEAD
Get the upload metadata.

Upload the given object data

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/data
PUT
Upload the object data.

Set the object body upload status to committed

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/status/committed
POST
Set the status of the object body upload to "committed"

Set the object body upload status to cancelled

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/status/cancelled
POST
Set the status of the object body to "cancelled"

User Scope

Create an object

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects
POST
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}/objects
POST
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}/objects
POST
By "me" literal

Retrieve an object

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}
GET
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}
GET
By "me" literal

Fully update an object / Create a new object with an ID

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}
PUT
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}
PUT
By "me" literal

Partially update an object

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}
PATCH
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}/objects/{objectID}
PATCH
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}
PATCH
By "me" literal

Delete an object

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}
DELETE
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}/objects/{objectID}
DELETE
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}
DELETE
By "me" literal

Check an object existence

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}
HEAD
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}/objects/{objectID}
HEAD
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}
HEAD
By "me" literal

Query for objects

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/query
POST
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}/query
POST
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}/query
POST
By "me" literal

Retrieve an object body

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}/body
GET
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body
GET
By "me" literal

Add or replace an object body

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}/body
PUT
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body
PUT
By "me" literal

Verify an object body existence

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}/body
HEAD
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body
HEAD
By "me" literal

Delete an object body

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}/body
DELETE
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}/objects/{objectID}/body
DELETE
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body
DELETE
By "me" literal

Move an object body

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}/body/move
POST
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body/move
POST
By "me" literal

Publish an object body

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}/body/publish
POST
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body/publish
POST
By "me" literal

Start uploading an object body

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}/body/uploads
POST
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body/uploads
POST
By "me" literal

Get the upload metadata

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}
HEAD
By "me" literal

Upload the given object data

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/data
PUT
By "me" literal

Set the object body upload status to committed

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/status/committed
POST
By "me" literal

Set the object body upload status to cancelled

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/status/cancelled
POST
By "me" literal

Thing Scope

Create an object

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects
POST
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}/objects
POST
By ID

Retrieve an object

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}
GET
By vendor ID

Fully update an object / Create a new object with an ID

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}
PUT
By vendor ID

Partially update an object

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}
PATCH
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}/objects/{objectID}
PATCH
By ID

Delete an object

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}
DELETE
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}/objects/{objectID}
DELETE
By ID

Check an object existence

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}
HEAD
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}/objects/{objectID}
HEAD
By ID

Query for objects

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/query
POST
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}/query
POST
By ID

Retrieve an object body

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}/body
GET
By vendor ID

Add or replace an object body

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}/body
PUT
By vendor ID

Verify an object body existence

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}/body
HEAD
By vendor ID

Delete an object body

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}/body
DELETE
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}/objects/{objectID}/body
DELETE
By ID

Publish an object body

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}/body/publish
POST
By vendor ID

Start uploading an object body

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}/body/uploads
POST
By vendor ID

Get the upload metadata

Upload the given object data

Set the object body upload status to committed

Set the object body upload status to cancelled

ACL Management

See also: Buckets, Setting a KiiObject's ACL

Set an ACL on Scope

Application Scope

Retrieve the current ACL entries

/api/apps/{appID}/acl
GET
Retrieve all ACL entries

/api/apps/{appID}/acl/{ACLVerb}
GET
Retrieve ACL entries with the specified ACL verb

Verify the permission

/api/apps/{appID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
Verify if the specified user has the permission

/api/apps/{appID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
Verify if the specified group has the permission

/api/apps/{appID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
Verify if the specified thing has the permission

Grant the permission

/api/apps/{appID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
Grant the permission to the specified user

/api/apps/{appID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
Grant the permission to the specified group

/api/apps/{appID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
Grant the permission to the specified thing

Revoke the permission

/api/apps/{appID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
Revoke the permission from the specified user

/api/apps/{appID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
Revoke the permission from the specified group

/api/apps/{appID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
Revoke the permission from the specified thing

Group Scope

Retrieve the current ACL entries

/api/apps/{appID}/groups/{groupID}/acl
GET
Retrieve all ACL entries

/api/apps/{appID}/groups/{groupID}/acl/{ACLVerb}
GET
Retrieve ACL entries with the specified ACL verb

Verify the permission

/api/apps/{appID}/groups/{groupID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
Verify if the specified user has the permission

/api/apps/{appID}/groups/{groupID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
Verify if the specified group has the permission

/api/apps/{appID}/groups/{groupID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
Verify if the specified thing has the permission

Grant the permission

/api/apps/{appID}/groups/{groupID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
Grant the permission to the specified user

/api/apps/{appID}/groups/{groupID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
Grant the permission to the specified group

/api/apps/{appID}/groups/{groupID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
Grant the permission to the specified thing

Revoke the permission

/api/apps/{appID}/groups/{groupID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
Revoke the permission from the specified user

/api/apps/{appID}/groups/{groupID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
Revoke the permission from the specified group

/api/apps/{appID}/groups/{groupID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
Revoke the permission from the specified thing

User Scope

Retrieve the current ACL entries

Retrieve all ACL entries

/api/apps/{appID}/users/{accountType}:{address}/acl
GET
By address

/api/apps/{appID}/users/me/acl
GET
By "me" literal

Retrieve ACL entries with the specified ACL verb

/api/apps/{appID}/users/{accountType}:{address}/acl/{ACLVerb}
GET
By address

/api/apps/{appID}/users/{userID}/acl/{ACLVerb}
GET
By ID

/api/apps/{appID}/users/me/acl/{ACLVerb}
GET
By "me" literal

Verify the permission

Verify if the specified user has the permission

/api/apps/{appID}/users/{accountType}:{address}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
By address

/api/apps/{appID}/users/me/acl/{ACLVerb}/UserID:{subjectUserID}
GET
By "me" literal

Verify if the specified group has the permission

/api/apps/{appID}/users/{accountType}:{address}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
By address

/api/apps/{appID}/users/me/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
By "me" literal

Verify if the specified thing has the permission

/api/apps/{appID}/users/{accountType}:{address}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
By address

/api/apps/{appID}/users/me/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
By "me" literal

Grant the permission

Grant the permission to the specified user

/api/apps/{appID}/users/{accountType}:{address}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
By address

/api/apps/{appID}/users/me/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
By "me" literal

Grant the permission to the specified group

/api/apps/{appID}/users/{accountType}:{address}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
By address

/api/apps/{appID}/users/me/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
By "me" literal

Grant the permission to the specified thing

/api/apps/{appID}/users/{accountType}:{address}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
By address

/api/apps/{appID}/users/me/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
By "me" literal

Revoke the permission

Revoke the permission from the specified user

/api/apps/{appID}/users/{accountType}:{address}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By address

/api/apps/{appID}/users/{userID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By ID

/api/apps/{appID}/users/me/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By "me" literal

Revoke the permission from the specified group

/api/apps/{appID}/users/{accountType}:{address}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By address

/api/apps/{appID}/users/{userID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By ID

/api/apps/{appID}/users/me/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By "me" literal

Revoke the permission from the specified thing

/api/apps/{appID}/users/{accountType}:{address}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By address

/api/apps/{appID}/users/{userID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By ID

/api/apps/{appID}/users/me/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By "me" literal

Thing Scope

Retrieve the current ACL entries

Retrieve all ACL entries

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl
GET
By vendor ID

Retrieve ACL entries with the specified ACL verb

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl/{ACLVerb}
GET
By vendor ID

/api/apps/{appID}/things/{thingID}/acl/{ACLVerb}
GET
By ID

Verify the permission

Verify if the specified user has the permission

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
By vendor ID

Verify if the specified group has the permission

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
By vendor ID

Verify if the specified thing has the permission

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
By vendor ID

Grant the permission

Grant the permission to the specified user

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
By vendor ID

Grant the permission to the specified group

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
By vendor ID

Grant the permission to the specified thing

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
By vendor ID

Revoke the permission

Revoke the permission from the specified user

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By vendor ID

/api/apps/{appID}/things/{thingID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By ID

Revoke the permission from the specified group

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By vendor ID

/api/apps/{appID}/things/{thingID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By ID

Revoke the permission from the specified thing

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By vendor ID

/api/apps/{appID}/things/{thingID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By ID

Set an ACL on Bucket

Application Scope

Retrieve the current ACL entries

/api/apps/{appID}/buckets/{bucketID}/acl
GET
Retrieve all ACL entries

/api/apps/{appID}/buckets/{bucketID}/acl/{ACLVerb}
GET
Retrieve ACL entries with the specified ACL verb

Verify the permission

/api/apps/{appID}/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
Verify if the specified user has the permission

/api/apps/{appID}/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
Verify if the specified group has the permission

/api/apps/{appID}/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
Verify if the specified thing has the permission

Grant the permission

/api/apps/{appID}/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
Grant the permission to the specified user

/api/apps/{appID}/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
Grant the permission to the specified group

/api/apps/{appID}/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
Grant the permission to the specified thing

Revoke the permission

/api/apps/{appID}/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
Revoke the permission from the specified user

/api/apps/{appID}/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
Revoke the permission from the specified group

/api/apps/{appID}/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
Revoke the permission from the specified thing

Group Scope

Retrieve the current ACL entries

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl
GET
Retrieve all ACL entries

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl/{ACLVerb}
GET
Retrieve ACL entries with the specified ACL verb

Verify the permission

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
Verify if the specified user has the permission

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
Verify if the specified group has the permission

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
Verify if the specified thing has the permission

Grant the permission

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
Grant the permission to the specified user

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
Grant the permission to the specified group

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
Grant the permission to the specified thing

Revoke the permission

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
Revoke the permission from the specified user

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
Revoke the permission from the specified group

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
Revoke the permission from the specified thing

User Scope

Retrieve the current ACL entries

Retrieve all ACL entries

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/acl
GET
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}/acl
GET
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}/acl
GET
By "me" literal

Retrieve ACL entries with the specified ACL verb

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/acl/{ACLVerb}
GET
By address

/api/apps/{appID}/users/{userID}/buckets/{bucketID}/acl/{ACLVerb}
GET
By ID

/api/apps/{appID}/users/me/buckets/{bucketID}/acl/{ACLVerb}
GET
By "me" literal

Verify the permission

Verify if the specified user has the permission

/api/apps/{appID}/users/me/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
By "me" literal

Verify if the specified group has the permission

/api/apps/{appID}/users/me/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
By "me" literal

Verify if the specified thing has the permission

/api/apps/{appID}/users/me/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
By "me" literal

Grant the permission

Grant the permission to the specified user

/api/apps/{appID}/users/me/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
By "me" literal

Grant the permission to the specified group

/api/apps/{appID}/users/me/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
By "me" literal

Grant the permission to the specified thing

/api/apps/{appID}/users/me/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
By "me" literal

Revoke the permission

Revoke the permission from the specified user

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By "me" literal

Revoke the permission from the specified group

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By "me" literal

Revoke the permission from the specified thing

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By "me" literal

Thing Scope

Retrieve the current ACL entries

Retrieve all ACL entries

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/acl
GET
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}/acl
GET
By ID

Retrieve ACL entries with the specified ACL verb

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/acl/{ACLVerb}
GET
By vendor ID

/api/apps/{appID}/things/{thingID}/buckets/{bucketID}/acl/{ACLVerb}
GET
By ID

Verify the permission

Verify if the specified user has the permission

Verify if the specified group has the permission

Verify if the specified thing has the permission

Grant the permission

Grant the permission to the specified user

Grant the permission to the specified group

Grant the permission to the specified thing

Revoke the permission

Revoke the permission from the specified user

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By vendor ID

Revoke the permission from the specified group

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By vendor ID

Revoke the permission from the specified thing

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By vendor ID

Set an ACL on Object

Application Scope

Retrieve the current ACL entries

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl
GET
Retrieve all ACL entries

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}
GET
Retrieve ACL entries with the specified ACL verb

Verify the permission

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
Verify if the specified user has the permission

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
Verify if the specified group has the permission

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
Verify if the specified thing has the permission

Grant the permission

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
Grant the permission to the specified user

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
Grant the permission to the specified group

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
Grant the permission to the specified thing

Revoke the permission

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
Revoke the permission from the specified user

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
Revoke the permission from the specified group

/api/apps/{appID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
Revoke the permission from the specified thing

Group Scope

Retrieve the current ACL entries

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl
GET
Retrieve all ACL entries

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}
GET
Retrieve ACL entries with the specified ACL verb

Verify the permission

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
Verify if the specified user has the permission

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
Verify if the specified group has the permission

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
Verify if the specified thing has the permission

Grant the permission

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
Grant the permission to the specified user

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
Grant the permission to the specified group

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
Grant the permission to the specified thing

Revoke the permission

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
Revoke the permission from the specified user

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
Revoke the permission from the specified group

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
Revoke the permission from the specified thing

User Scope

Retrieve the current ACL entries

Retrieve all ACL entries

/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}/acl
GET
By address

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl
GET
By "me" literal

Retrieve ACL entries with the specified ACL verb

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}
GET
By "me" literal

Verify the permission

Verify if the specified user has the permission

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
By "me" literal

Verify if the specified group has the permission

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
By "me" literal

Verify if the specified thing has the permission

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
By "me" literal

Grant the permission

Grant the permission to the specified user

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
By "me" literal

Grant the permission to the specified group

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
By "me" literal

Grant the permission to the specified thing

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
By "me" literal

Revoke the permission

Revoke the permission from the specified user

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By "me" literal

Revoke the permission from the specified group

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By "me" literal

Revoke the permission from the specified thing

/api/apps/{appID}/users/me/buckets/{bucketID}/objects/{objectID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By "me" literal

Thing Scope

Retrieve the current ACL entries

Retrieve all ACL entries

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}/acl
GET
By vendor ID

Retrieve ACL entries with the specified ACL verb

Verify the permission

Verify if the specified user has the permission

Verify if the specified group has the permission

Verify if the specified thing has the permission

Grant the permission

Grant the permission to the specified user

Grant the permission to the specified group

Grant the permission to the specified thing

Revoke the permission

Revoke the permission from the specified user

Revoke the permission from the specified group

Revoke the permission from the specified thing

Set an ACL on Topic

Application Scope

Retrieve the current ACL entries

/api/apps/{appID}/topics/{topicID}/acl
GET
Retrieve all ACL entries

/api/apps/{appID}/topics/{topicID}/acl/{ACLVerb}
GET
Retrieve ACL entries with the specified ACL verb

Verify the permission

/api/apps/{appID}/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
Verify if the specified user has the permission

/api/apps/{appID}/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
Verify if the specified group has the permission

/api/apps/{appID}/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
Verify if the specified thing has the permission

Grant the permission

/api/apps/{appID}/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
Grant the permission to the specified user

/api/apps/{appID}/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
Grant the permission to the specified group

/api/apps/{appID}/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
Grant the permission to the specified thing

Revoke the permission

/api/apps/{appID}/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
Revoke the permission from the specified user

/api/apps/{appID}/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
Revoke the permission from the specified group

/api/apps/{appID}/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
Revoke the permission from the specified thing

Group Scope

Retrieve the current ACL entries

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl
GET
Retrieve all ACL entries

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl/{ACLVerb}
GET
Retrieve ACL entries with the specified ACL verb

Verify the permission

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
Verify if the specified user has the permission

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
Verify if the specified group has the permission

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
Verify if the specified thing has the permission

Grant the permission

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
Grant the permission to the specified user

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
Grant the permission to the specified group

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
Grant the permission to the specified thing

Revoke the permission

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
Revoke the permission from the specified user

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
Revoke the permission from the specified group

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
Revoke the permission from the specified thing

User Scope

Retrieve the current ACL entries

Retrieve all ACL entries

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/acl
GET
By address

/api/apps/{appID}/users/{userID}/topics/{topicID}/acl
GET
By ID

/api/apps/{appID}/users/me/topics/{topicID}/acl
GET
By "me" literal

Retrieve ACL entries with the specified ACL verb

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/acl/{ACLVerb}
GET
By address

/api/apps/{appID}/users/{userID}/topics/{topicID}/acl/{ACLVerb}
GET
By ID

/api/apps/{appID}/users/me/topics/{topicID}/acl/{ACLVerb}
GET
By "me" literal

Verify the permission

Verify if the specified user has the permission

/api/apps/{appID}/users/me/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
GET
By "me" literal

Verify if the specified group has the permission

/api/apps/{appID}/users/me/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
GET
By "me" literal

Verify if the specified thing has the permission

/api/apps/{appID}/users/me/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
GET
By "me" literal

Grant the permission

Grant the permission to the specified user

/api/apps/{appID}/users/me/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
PUT
By "me" literal

Grant the permission to the specified group

/api/apps/{appID}/users/me/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
PUT
By "me" literal

Grant the permission to the specified thing

/api/apps/{appID}/users/me/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
PUT
By "me" literal

Revoke the permission

Revoke the permission from the specified user

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By address

/api/apps/{appID}/users/me/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By "me" literal

Revoke the permission from the specified group

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By address

/api/apps/{appID}/users/me/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By "me" literal

Revoke the permission from the specified Thing

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By address

/api/apps/{appID}/users/me/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By "me" literal

Thing Scope

Retrieve the current ACL entries

Retrieve all ACL entries

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/acl
GET
By vendor ID

/api/apps/{appID}/things/{thingID}/topics/{topicID}/acl
GET
By ID

Retrieve ACL entries with the specified ACL verb

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/acl/{ACLVerb}
GET
By vendor ID

/api/apps/{appID}/things/{thingID}/topics/{topicID}/acl/{ACLVerb}
GET
By ID

Verify the permission

Verify if the specified user has the permission

Verify if the specified group has the permission

Verify if the specified thing has the permission

Grant the permission

Grant the permission to the specified user

Grant the permission to the specified group

Grant the permission to the specified thing

Revoke the permission

Revoke the permission from the specified user

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/acl/{ACLVerb}/UserID:{subjectUserID}
DELETE
By vendor ID

Revoke the permission from the specified group

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/acl/{ACLVerb}/GroupID:{subjectGroupID}
DELETE
By vendor ID

Revoke the permission from the specified Thing

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/acl/{ACLVerb}/ThingID:{subjectThingID}
DELETE
By vendor ID

Notification Management

See also: Managing Push Notifications

Manage the user/thing device installation

Register a new device

/api/apps/{appID}/installations
POST
Register a new installation.

Retrieve the registered installations

/api/apps/{appID}/installations
GET
Retrieve the installations.

Check the registered installation by the installation ID

/api/apps/{appID}/installations/{installationID}
GET
Retrieve the installation data.

Delete the installation

/api/apps/{appID}/installations/{installationID}
DELETE
By ID

/api/apps/{appID}/installations/{deviceType}:{installationRegistrationID}
DELETE
By registration ID

Get the MQTT endpoint information

/api/apps/{appID}/installations/{installationID}/mqtt-endpoint
GET
By ID

/api/apps/{appID}/installations/{deviceType}:{installationRegistrationID}/mqtt-endpoint
GET
By registration ID

Leverage "Push to App" notification

See also: Receiving a Push to App Notification

Leverage bucket notification

Application Scope

Subscribe the current user to the bucket

/api/apps/{appID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users
POST
Subscribe the current authenticated user to the filter.

Subscribe the specified user to the bucket

/api/apps/{appID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
PUT
Subscribe this user to the current filter.

Check if the specified user is subscribed to the bucket

/api/apps/{appID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
GET
Check if this user is subscribed to the current filter.

Unsubscribe the specified user from the bucket

/api/apps/{appID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
DELETE
Unsubscribe this user from the current filter.

Subscribe the current thing to the bucket

/api/apps/{appID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things
POST
Subscribe the current authenticated thing to the filter.

Subscribe the specified thing to the bucket

/api/apps/{appID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things/{thingID}
PUT
Subscribe this thing to the current filter.

Check if the specified thing is subscribed to the bucket

/api/apps/{appID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things/{thingID}
GET
Check if this thing is subscribed to the current filter.

Unsubscribe the specified thing from the bucket

/api/apps/{appID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things/{thingID}
DELETE
Unsubscribe this thing from the current filter.

Group Scope

Subscribe the current user to the bucket

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users
POST
Subscribe the current authenticated user to the filter.

Subscribe the specified user to the bucket

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
PUT
Subscribe this user to the current filter.

Check if the specified user is subscribed to the bucket

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
GET
Check if this user is subscribed to the current filter.

Unsubscribe the specified user from the bucket

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
DELETE
Unsubscribe this user from the current filter.

Subscribe the current thing to the bucket

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things
POST
Subscribe the current authenticated thing to the filter.

Subscribe the specified thing to the bucket

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things/{thingID}
PUT
Subscribe this thing to the current filter.

Check if the specified thing is subscribed to the bucket

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things/{thingID}
GET
Check if this thing is subscribed to the current filter.

Unsubscribe the specified thing from the bucket

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things/{thingID}
DELETE
Unsubscribe this thing from the current filter.

User Scope

Subscribe the current user to the bucket

/api/apps/{appID}/users/me/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users
POST
By "me" literal

Subscribe the specified user to the bucket

/api/apps/{appID}/users/me/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
PUT
by "me" literal

Check if the specified user is subscribed to the bucket

/api/apps/{appID}/users/me/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
GET
by "me" literal

Unsubscribe the specified user from the bucket

/api/apps/{appID}/users/me/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
DELETE
by "me" literal

Subscribe the current thing to the bucket

Subscribe the specified thing to the bucket

/api/apps/{appID}/users/me/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things/{thingID}
PUT
by "me" literal

Check if the specified thing is subscribed to the bucket

/api/apps/{appID}/users/me/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things/{thingID}
GET
by "me" literal

Unsubscribe the specified thing from the bucket

/api/apps/{appID}/users/me/buckets/{bucketID}/filters/{filterID}/push/subscriptions/things/{thingID}
DELETE
by "me" literal

Thing Scope

Subscribe the current user to the bucket

Subscribe the specified user to the bucket

Check if the specified user is subscribed to the bucket

Unsubscribe the specified user from the bucket

Subscribe the current thing to the bucket

Subscribe the specified thing to the bucket

Check if the specified thing is subscribed to the bucket

Unsubscribe the specified thing from the bucket

Leverage "Push to Users" notification

See also: Push to User Notification

Application Scope

Manage topics

Get a list of available topics

/api/apps/{appID}/topics
GET
Obtain the list of the available topics in the application, user, group or thing being accessed

Create a new topic

/api/apps/{appID}/topics/{topicID}
PUT
Create a new topic.

Check the topic existence

/api/apps/{appID}/topics/{topicID}
HEAD
Check the topic exists.

Check the topic existence (currently same as HEAD method)

/api/apps/{appID}/topics/{topicID}
GET
Response 200 is for getting the topic, but currently does not returns any value and acts like head method.

Delete the topic

/api/apps/{appID}/topics/{topicID}
DELETE
Delete the topic with all the subscriptions it has.

Subscribe/unsubscribe topics

Subscribe the current user to the topic

/api/apps/{appID}/topics/{topicID}/push/subscriptions/users
POST
Subscribe the current authenticated user to the topic.

Subscribe the specified user to the topic

/api/apps/{appID}/topics/{topicID}/push/subscriptions/users/{userID}
PUT
Subscribe this user to the current topic.

Check if the specified user is subscribed to the topic

/api/apps/{appID}/topics/{topicID}/push/subscriptions/users/{userID}
HEAD
Check if this user is subscribed to the current topic.

Check if the specified user is subscribed to the topic (currently same as HEAD method)

/api/apps/{appID}/topics/{topicID}/push/subscriptions/users/{userID}
GET
Check if this user is subscribed to the current topic.

Unsubscribe the specified user from the topic

/api/apps/{appID}/topics/{topicID}/push/subscriptions/users/{userID}
DELETE
Unsubscribe this user from the current topic.

Subscribe the current thing to the topic

/api/apps/{appID}/topics/{topicID}/push/subscriptions/things
POST
Subscribe the current authenticated thing to the topic.

Subscribe the specified thing to the topic

/api/apps/{appID}/topics/{topicID}/push/subscriptions/things/{thingID}
PUT
Subscribe this thing to the current topic.

Check if the specified thing is subscribed to the topic

/api/apps/{appID}/topics/{topicID}/push/subscriptions/things/{thingID}
HEAD
Check if this thing is subscribed to the current topic.

Check if the specified thing is subscribed to the topic (currently same as HEAD method)

/api/apps/{appID}/topics/{topicID}/push/subscriptions/things/{thingID}
GET
Check if this thing is subscribed to the current topic.

Unsubscribe the specified thing from the topic

/api/apps/{appID}/topics/{topicID}/push/subscriptions/things/{thingID}
DELETE
Unsubscribe this thing from the current topic.

Send messages

Send a push message to the current topic

/api/apps/{appID}/topics/{topicID}/push/messages
POST
Send a push message to the current topic.

Group Scope

Manage topics

Get a list of available topics

/api/apps/{appID}/groups/{groupID}/topics
GET
Obtain the list of the available topics in the application, user, group or thing being accessed

Create a new topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}
PUT
Create a new topic.

Check the topic existence

/api/apps/{appID}/groups/{groupID}/topics/{topicID}
HEAD
Check the topic exists.

Check the topic existence (currently same as HEAD method)

/api/apps/{appID}/groups/{groupID}/topics/{topicID}
GET
Response 200 is for getting the topic, but currently does not returns any value and acts like head method.

Delete the topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}
DELETE
Delete the topic with all the subscriptions it has.

Subscribe/unsubscribe topics

Subscribe the current user to the topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/subscriptions/users
POST
Subscribe the current authenticated user to the topic.

Subscribe the specified user to the topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/subscriptions/users/{userID}
PUT
Subscribe this user to the current topic.

Check if the specified user is subscribed to the topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/subscriptions/users/{userID}
HEAD
Check if this user is subscribed to the current topic.

Check if the specified user is subscribed to the topic (currently same as HEAD method)

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/subscriptions/users/{userID}
GET
Check if this user is subscribed to the current topic.

Unsubscribe the specified user from the topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/subscriptions/users/{userID}
DELETE
Unsubscribe this user from the current topic.

Subscribe the current thing to the topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/subscriptions/things
POST
Subscribe the current authenticated thing to the topic.

Subscribe the specified thing to the topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/subscriptions/things/{thingID}
PUT
Subscribe this thing to the current topic.

Check if the specified thing is subscribed to the topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/subscriptions/things/{thingID}
HEAD
Check if this thing is subscribed to the current topic.

Check if the specified thing is subscribed to the topic (currently same as HEAD method)

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/subscriptions/things/{thingID}
GET
Check if this thing is subscribed to the current topic.

Unsubscribe the specified thing from the topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/subscriptions/things/{thingID}
DELETE
Unsubscribe this thing from the current topic.

Send messages

Send a push message to the current topic

/api/apps/{appID}/groups/{groupID}/topics/{topicID}/push/messages
POST
Send a push message to the current topic.

User Scope

Manage topics

Get a list of available topics

/api/apps/{appID}/users/{accountType}:{address}/topics
GET
By address

/api/apps/{appID}/users/me/topics
GET
By "me" literal

Create a new topic

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}
PUT
By address

/api/apps/{appID}/users/{userID}/topics/{topicID}
PUT
By ID

/api/apps/{appID}/users/me/topics/{topicID}
PUT
By "me" literal

Check the topic existence

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}
HEAD
By address

/api/apps/{appID}/users/{userID}/topics/{topicID}
HEAD
By ID

/api/apps/{appID}/users/me/topics/{topicID}
HEAD
By "me" literal

Check the topic existence (currently same as HEAD method)

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}
GET
By address

/api/apps/{appID}/users/{userID}/topics/{topicID}
GET
By ID

/api/apps/{appID}/users/me/topics/{topicID}
GET
By "me" literal

Delete the topic

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}
DELETE
By address

/api/apps/{appID}/users/{userID}/topics/{topicID}
DELETE
By ID

/api/apps/{appID}/users/me/topics/{topicID}
DELETE
By "me" literal

Subscribe/unsubscribe topics

Subscribe the current user to the topic

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/push/subscriptions/users
POST
By address

/api/apps/{appID}/users/me/topics/{topicID}/push/subscriptions/users
POST
By "me" literal

Subscribe the specified user to the topic

/api/apps/{appID}/users/me/topics/{topicID}/push/subscriptions/users/{userID}
PUT
By "me" literal

Check if the specified user is subscribed to the topic

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/push/subscriptions/users/{userID}
HEAD
By address

/api/apps/{appID}/users/me/topics/{topicID}/push/subscriptions/users/{userID}
HEAD
By "me" literal

Check if the specified user is subscribed to the topic (currently same as HEAD method)

/api/apps/{appID}/users/me/topics/{topicID}/push/subscriptions/users/{userID}
GET
By "me" literal

Unsubscribe the specified user from the topic

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/push/subscriptions/users/{userID}
DELETE
By address

/api/apps/{appID}/users/{userID}/topics/{topicID}/push/subscriptions/users/{userID}
DELETE
By ID

/api/apps/{appID}/users/me/topics/{topicID}/push/subscriptions/users/{userID}
DELETE
By "me" literal

Subscribe the current thing to the topic

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/push/subscriptions/things
POST
By address

Subscribe the specified thing to the topic

/api/apps/{appID}/users/me/topics/{topicID}/push/subscriptions/things/{thingID}
PUT
By "me" literal

Check if the specified thing is subscribed to the topic

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/push/subscriptions/things/{thingID}
HEAD
By address

/api/apps/{appID}/users/me/topics/{topicID}/push/subscriptions/things/{thingID}
HEAD
By "me" literal

Check if the specified thing is subscribed to the topic (currently same as HEAD method)

/api/apps/{appID}/users/me/topics/{topicID}/push/subscriptions/things/{thingID}
GET
By "me" literal

Unsubscribe the specified thing from the topic

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/push/subscriptions/things/{thingID}
DELETE
By address

/api/apps/{appID}/users/{userID}/topics/{topicID}/push/subscriptions/things/{thingID}
DELETE
By ID

/api/apps/{appID}/users/me/topics/{topicID}/push/subscriptions/things/{thingID}
DELETE
By "me" literal

Send messages

Send a push message to the current topic

/api/apps/{appID}/users/{accountType}:{address}/topics/{topicID}/push/messages
POST
By address

/api/apps/{appID}/users/{userID}/topics/{topicID}/push/messages
POST
By ID

/api/apps/{appID}/users/me/topics/{topicID}/push/messages
POST
By "me" literal

Thing Scope

Manage topics

Get a list of available topics

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics
GET
By vendor ID

/api/apps/{appID}/things/{thingID}/topics
GET
By ID

Create a new topic

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}
PUT
By vendor ID

/api/apps/{appID}/things/{thingID}/topics/{topicID}
PUT
By ID

Check the topic existence

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}
HEAD
By vendor ID

/api/apps/{appID}/things/{thingID}/topics/{topicID}
HEAD
By ID

Check the topic existence (currently same as HEAD method)

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}
GET
By vendor ID

/api/apps/{appID}/things/{thingID}/topics/{topicID}
GET
By ID

Delete the topic

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}
DELETE
By vendor ID

/api/apps/{appID}/things/{thingID}/topics/{topicID}
DELETE
By ID

Subscribe/unsubscribe topics

Subscribe the current user to the topic

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/push/subscriptions/users
POST
By vendor ID

Subscribe the specified user to the topic

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/push/subscriptions/users/{userID}
PUT
By vendor ID

Check if the specified user is subscribed to the topic

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/push/subscriptions/users/{userID}
HEAD
By vendor ID

Check if the specified user is subscribed to the topic (currently same as HEAD method)

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/push/subscriptions/users/{userID}
GET
By vendor ID

Unsubscribe the specified user from the topic

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/push/subscriptions/users/{userID}
DELETE
By vendor ID

/api/apps/{appID}/things/{thingID}/topics/{topicID}/push/subscriptions/users/{userID}
DELETE
By ID

Subscribe the current thing to the topic

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/push/subscriptions/things
POST
By vendor ID

Subscribe the specified thing to the topic

Check if the specified thing is subscribed to the topic

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/push/subscriptions/things/{thingID}
HEAD
By vendor ID

Check if the specified thing is subscribed to the topic (currently same as HEAD method)

Unsubscribe the specified thing from the topic

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/push/subscriptions/things/{thingID}
DELETE
By vendor ID

Send messages

Send a push message to the current topic

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/topics/{topicID}/push/messages
POST
By vendor ID

/api/apps/{appID}/things/{thingID}/topics/{topicID}/push/messages
POST
By ID

Leverage "Direct Push" notification

See also: Direct Push Notification

Send mesasges

/api/apps/{appID}/users/{accountType}:{address}/push/messages
POST
By address

/api/apps/{appID}/users/{userID}/push/messages
POST
By ID

Server Extension

See also: Server Extension Programming Guide

Execute the server code

Execute the current version

/api/apps/{appID}/server-code/versions/current/{ENDPOINT_NAME}
POST
Invoke the endpoint of the server code.

User Management
Group Management
Thing Management
Data Management
ACL Management
Notification Management
Server Extension
- Execute the server code
- - Execute the current version