Broadcast Controller | Version 2022

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

broadcastIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/broadcasts/{broadcastId}

GET /api/broadcasts/{broadcastId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "username": "text",
  "ipAddr": "text",
  "streamId": "text",
  "type": "text",
  "status": "text",
  "description": "text",
  "streamUrl": "text",
  "password": "text",
  "name": "text"
}

put

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

broadcastIdstringRequired

Body

usernamestringOptional

ipAddrstringOptional

streamIdstringOptional

typestringOptional

statusstringOptional

descriptionstringOptional

streamUrlstringOptional

passwordstringOptional

namestringOptional

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

/api/broadcasts/{broadcastId}

PUT /api/broadcasts/{broadcastId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "username": "text",
  "ipAddr": "text",
  "streamId": "text",
  "type": "text",
  "status": "text",
  "description": "text",
  "streamUrl": "text",
  "password": "text",
  "name": "text"
}

No content

delete

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

broadcastIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/broadcasts/{broadcastId}

DELETE /api/broadcasts/{broadcastId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/broadcasts

GET /api/broadcasts HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "username": "text",
    "ipAddr": "text",
    "streamId": "text",
    "type": "text",
    "status": "text",
    "description": "text",
    "streamUrl": "text",
    "password": "text",
    "name": "text"
  }
]

post

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Body

usernamestringOptional

ipAddrstringOptional

streamIdstringOptional

typestringOptional

statusstringOptional

descriptionstringOptional

streamUrlstringOptional

passwordstringOptional

namestringOptional

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/broadcasts

POST /api/broadcasts HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "username": "text",
  "ipAddr": "text",
  "streamId": "text",
  "type": "text",
  "status": "text",
  "description": "text",
  "streamUrl": "text",
  "password": "text",
  "name": "text"
}

{
  "username": "text",
  "ipAddr": "text",
  "streamId": "text",
  "type": "text",
  "status": "text",
  "description": "text",
  "streamUrl": "text",
  "password": "text",
  "name": "text"
}

post

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

broadcastIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/broadcasts/{broadcastId}/stop

POST /api/broadcasts/{broadcastId}/stop HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

post

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

broadcastIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/broadcasts/{broadcastId}/start

POST /api/broadcasts/{broadcastId}/start HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters

filterstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/broadcasts/search

GET /api/broadcasts/search?filter=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "username": "text",
    "ipAddr": "text",
    "streamId": "text",
    "type": "text",
    "status": "text",
    "description": "text",
    "streamUrl": "text",
    "password": "text",
    "name": "text"
  }
]

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters

filterstringRequired

Responses

200

OK

*/*

Responseinteger · int32

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/broadcasts/search/count

GET /api/broadcasts/search/count?filter=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Responses

200

OK

*/*

Responseinteger · int32

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/broadcasts/count

GET /api/broadcasts/count HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*