CHANNEL

All Channels

get

https://api.example.comhttps://staging-api.example.com

/api/v1/channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

get

/api/v1/channel

HTTPcURLJavaScriptPython

GET /api/v1/channel HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Create Channel

post

https://api.example.comhttps://staging-api.example.com

/api/v1/channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"name":"Demo Channel","typeId":1,"scopes":[18]}

Responses

200

Successful response

application/json

post

/api/v1/channel

HTTPcURLJavaScriptPython

POST /api/v1/channel HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "name": "Demo Channel",
  "typeId": 1,
  "scopes": [
    18
  ]
}

200

Successful response

No content

Single Channel

get

https://api.example.comhttps://staging-api.example.com

/api/v1/channel/{channelId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

channelIdintegerRequiredExample: 3

Responses

200

Successful response

application/json

get

/api/v1/channel/{channelId}

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channelId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Edit Channel

put

https://api.example.comhttps://staging-api.example.com

/api/v1/channel/{channelId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

channelIdintegerRequiredExample: 3

Body

application/json

objectOptionalExample: {"name":"Updated Channel Name","typeId":2,"scopes":[4,7],"enabled":true,"cidr":"10.0.0.0/24,172.16.0.0/12"}

Responses

200

Successful response

application/json

put

/api/v1/channel/{channelId}

HTTPcURLJavaScriptPython

PUT /api/v1/channel/{channelId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "name": "Updated Channel Name",
  "typeId": 2,
  "scopes": [
    4,
    7
  ],
  "enabled": true,
  "cidr": "10.0.0.0/24,172.16.0.0/12"
}

200

Successful response

No content

Single Channel - Scopes

get

https://api.example.comhttps://staging-api.example.com

/api/v1/channel/{channelId}/scopes

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

channelIdintegerRequiredExample: 3

Responses

200

Successful response

application/json

get

/api/v1/channel/{channelId}/scopes

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channelId}/scopes HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Channel - Toggle

post

https://api.example.comhttps://staging-api.example.com

/api/v1/channel/{channelId}/toggle

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

channelIdintegerRequiredExample: 2

Body

application/json

objectOptional

Responses

200

Successful response

application/json

post

/api/v1/channel/{channelId}/toggle

HTTPcURLJavaScriptPython

POST /api/v1/channel/{channelId}/toggle HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

No content

Delete Channel

delete

https://api.example.comhttps://staging-api.example.com

/api/v1/channel/{channelId}/delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

channelIdintegerRequiredExample: 11

Responses

200

Successful response

application/json

delete

/api/v1/channel/{channelId}/delete

HTTPcURLJavaScriptPython

DELETE /api/v1/channel/{channelId}/delete HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Verify Channel Token

get

https://api.example.comhttps://staging-api.example.com

/api/v1/channel/verify/token/{token}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequiredExample: abc123def456ghi789jkl012mno345pqr678stu901vwx234

Responses

200

Successful response

application/json

get

/api/v1/channel/verify/token/{token}

HTTPcURLJavaScriptPython

GET /api/v1/channel/verify/token/{token} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Retrieve Channel Data By Token

get

https://api.example.comhttps://staging-api.example.com

/api/v1/channel/retrieve/token/{token}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequiredExample: abc123def456ghi789jkl012mno345pqr678stu901vwx234

Responses

200

Successful response

application/json

get

/api/v1/channel/retrieve/token/{token}

HTTPcURLJavaScriptPython

GET /api/v1/channel/retrieve/token/{token} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Retrieve Organization With Channel Token

get

https://api.example.comhttps://staging-api.example.com

/api/v1/channel/{token}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequiredExample: abc123def456ghi789jkl012mno345pqr678stu901vwx234

Responses

200

Successful response

application/json

get

/api/v1/channel/{token}

HTTPcURLJavaScriptPython

GET /api/v1/channel/{token} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content