CloudWS (1)

Download OpenAPI specification:Download

Authentication

token

Security scheme type: API Key
Header parameter name: token

Channel

Get list of your channels

Authorizations:

Responses

200

Return list of your channels

401

Unauthorized

get /
https://cloudws.io/api/channel/

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Create new channel

Authorizations:

Responses

200

Return created channel

401

Unauthorized

post /
https://cloudws.io/api/channel/

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "totalMessages": 0,
  • "lastActionTimestamp": 0
}

Delete existent channel

Authorizations:
path Parameters
name
required
string

Name of your channel

Responses

200

Channel successfully deleted

401

Unauthorized

404

Not Found

delete /${name}
https://cloudws.io/api/channel/${name}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "AuthorizationRequiredError",
  • "message": "string"
}

Message

Send message to channel

Authorizations:
path Parameters
name
required
string

Name of your channel

Responses

200

Message successfully sent to channel

401

Unauthorized

404

Not Found

post /${name}/message
https://cloudws.io/api/channel/${name}/message

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "AuthorizationRequiredError",
  • "message": "string"
}