Theme

Topics ​

API endpoints for Topics management in IOTSP.

Register topic ​

http
POST /v1/iotsp/topics/register

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Register topicRequest {
  path: string;
  qos: string;
  description: string;
  tags: string[];
}

Example:

json
{
  "path": "test/device",
  "qos": "0",
  "description": "Listen to user device test reports",
  "tags": [
    "spx"
  ]
}

Get Topic specs ​

http
GET /v1/iotsp/topics/:reference

Headers ​

  • origin (required)
  • de-auth-token (required)
  • de-auth-device (required)
  • de-user-agent (required)

Find topic ​

http
GET /v1/iotsp/topics/find?query=test

Headers ​

  • de-auth-token (required)
  • de-auth-device (required)
  • de-user-agent (required)

Fetch all topics ​

http
GET /v1/iotsp/topics

Headers ​

  • de-auth-token (required)
  • de-auth-device (required)
  • de-user-agent (required)

Update topic specs ​

http
PATCH /v1/iotsp/topics/:reference

Headers ​

  • de-auth-token (required)
  • de-auth-device (required)
  • de-user-agent (required)

Request Body ​

typescript
interface Update topic specsRequest {
  tags: string[];
}

Example:

json
{
  "tags": [
    "dev",
    "debug",
    "rollback"
  ]
}

Update topic status ​

http
PATCH /v1/iotsp/topics/:reference/:status

Headers ​

  • de-auth-token (required)
  • de-auth-device (required)
  • de-user-agent (required)

Unregister topic ​

http
DELETE /v1/iotsp/topics/:reference

Headers ​

  • de-auth-token (required)
  • de-auth-device (required)
  • de-user-agent (required)

Assign topic to an IoT Connector type ​

http
PUT /v1/iotsp/topics/:reference/connector/assign

Headers ​

  • de-auth-token (required)
  • de-auth-device (required)
  • de-user-agent (required)

Unassign topic from an IoT Connector type ​

http
PATCH /v1/iotsp/topics/:reference/connector/unassign

Headers ​

  • de-auth-token (required)
  • de-auth-device (required)
  • de-user-agent (required)

Get connectors using this topic ​

http
GET /v1/iotsp/topics/:reference/connectors

Headers ​

  • de-auth-token (required)
  • de-auth-device (required)
  • de-user-agent (required)