Add subscriptions

post/subscriptions/v1beta1/subscriptions

Add one or more subscriptions to a workspace.

NOTE: You need to have the edit permission for the Devices and Subscription service to invoke this API.

This API provides an asynchronous response and will always return 202 Accepted if basic input validations are successful. The location header in the response provides the URI to be invoked for fetching progress of the subscription addition task. For details about the status fetch URL, refer to the API Get progress or status of async operations in subscriptions.

Rate limits are enforced on this API. Four requests per minute is supported per workspace, and the API returns a 429 status code if this threshold is breached.

SecurityBearer
Request
Request Body schema: application/json
required

Maximum five subscriptions per request.

required
Array of objects (RequestPostSubscription)

An array of subscription keys.

Responses
202

Request accepted

400

Bad request

401

Unauthorized request

403

The operation is forbidden

422

Validation error

429

Too many requests

500

Internal server error

Request samples
application/json
{
  • "subscriptions": [
    ]
}
Response samples
application/json
{
  • "code": 0,
  • "status": "100 CONTINUE",
  • "transactionId": "string"
}