REST API Interface
Swagger
The Recaster's REST API offers seamless integration and control for users through the intuitive Swagger interface. Swagger serves as a powerful tool to visualize, interact with, and manage the API effortlessly. With Swagger, users can explore the Recaster's API endpoints, understand request parameters, and view responses in a user-friendly and interactive documentation format.
You can acces Swagger's intuitive interface at http://localhost:5173/api/docs/
API Endpoints
The REST API provides various endpoints for managing platforms, channels, and their behavior. Refer to the API documentation for a comprehensive list of available endpoints and their functionalities.
/api/info
GET
Description:
return the vendor information
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| No parameters |
|
|
|
|
Responses
| Code |
Description |
| 200 |
Company |
/api/health
GET
Description:
returns OK. Used for checking if the server is online.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| No parameters |
|
|
|
|
Responses
/api/nics
GET
Description:
Returns an array of existing network interfaces.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| No parameters |
|
|
|
|
Responses
/api/bitrates
GET
Description:
Returns an array of bitrates readings.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| channelId |
query |
Channel Id |
No |
string |
Responses
| Code |
Description |
| 200 |
returns an array of streamBitrates |
/api/streamDetectionInfo
GET
Description:
Retrieves stream detection information for channels.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| channelId |
query |
Channel Id |
No |
string |
Responses
/api/docs
GET
Description:
Swagger.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| No parameters |
|
|
|
|
POST
Description:
POST request to execute start/stop command for a platform with a specified ID.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
The ID of the platform to start or stop |
|
|
| command |
query |
The command to perform on the platform (either 'start' or 'stop') |
|
|
/api/channels/command
POST
Description:
A POST request to execute start/stop/detect command for a channel with a specified ID.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
The ID of the channel to start, stop, or detect |
|
|
| command |
query |
The command to perform on the channel (either 'start', 'stop', or 'detect') |
|
|
Samples:
Start Channel
POST http://{{ host }}/api/channels/command
content-type: application/json
{
"channelId": "cls7n5o3c0001b4a54c6re7l1",
"command": "start"
}
POST http://{{ host }}/api/channels/command
content-type: application/json
{
"channelId": "cls7n5o3c0001b4a54c6re7l1",
"command": "stop"
}
POST http://{{ host }}/api/channels/command
content-type: application/json
{
"channelId": "cls7n5o3c0001b4a54c6re7l1",
"command": "detect"
}
/api/server/uploadLicense
POST
Description:
POST request to upload the license
POST
Description:
POST request to upload the platforms
/api/channels/:channelId
DELETE
Description:
DELETE request to delete a channel with a specified ID.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
The ID of the channel to delete |
|
|
Automaticall generated endpoints:
GET
Description:
return an array of platforms. supports filter operators. For more info on filtering see this article
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| _limit |
query |
limit the number of returned rows, default 100 |
No |
integer |
| _page |
query |
to be used for paging |
No |
integer |
| _sort |
query |
the columns to sort on |
No |
string |
| _order |
query |
the sort order to user for the columns in _sort |
No |
string |
| id |
query |
filter equal to id. See more filtering options |
No |
string |
| createdAt |
query |
filter equal to createdAt. See more filtering options |
No |
string |
| name |
query |
filter equal to name. See more filtering options |
No |
string |
| description |
query |
filter equal to description. See more filtering options |
No |
string |
| channels |
query |
filter equal to channels. See more filtering options |
No |
object |
Responses
| Code |
Description |
| 200 |
returns an array of platforms |
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
GET
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
id of platforms |
Yes |
string |
Responses
PUT
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
id of platforms |
Yes |
string |
Responses
| Code |
Description |
| 200 |
successful operation |
| 400 |
Error: Bad Request |
DELETE
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
id of platforms |
Yes |
string |
Responses
| Code |
Description |
| 204 |
Deleted |
| 400 |
Error: Bad Request |
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
/api/serverStatus
GET
Description:
return an array of serverStatus. supports filter operators. For more info on filtering see this article
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| _limit |
query |
limit the number of returned rows, default 100 |
No |
integer |
| _page |
query |
to be used for paging |
No |
integer |
| _sort |
query |
the columns to sort on |
No |
string |
| _order |
query |
the sort order to user for the columns in _sort |
No |
string |
| id |
query |
filter equal to id. See more filtering options |
No |
number |
| startedAt |
query |
filter equal to startedAt. See more filtering options |
No |
string |
| state |
query |
filter equal to state. See more filtering options |
No |
object |
| errorMessage |
query |
filter equal to errorMessage. See more filtering options |
No |
string |
Responses
| Code |
Description |
| 200 |
returns an array of serverStatus |
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
/api/serverStatus/{id}
GET
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
id of serverStatus |
Yes |
string |
Responses
PUT
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
id of serverStatus |
Yes |
string |
Responses
| Code |
Description |
| 200 |
successful operation |
| 400 |
Error: Bad Request |
DELETE
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
id of serverStatus |
Yes |
string |
Responses
| Code |
Description |
| 204 |
Deleted |
| 400 |
Error: Bad Request |
/api/logMessages
GET
Description:
return an array of logMessages. supports filter operators. For more info on filtering see this article
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| _limit |
query |
limit the number of returned rows, default 100 |
No |
integer |
| _page |
query |
to be used for paging |
No |
integer |
| _sort |
query |
the columns to sort on |
No |
string |
| _order |
query |
the sort order to user for the columns in _sort |
No |
string |
| id |
query |
filter equal to id. See more filtering options |
No |
number |
| time |
query |
filter equal to time. See more filtering options |
No |
string |
| type |
query |
filter equal to type. See more filtering options |
No |
object |
| message |
query |
filter equal to message. See more filtering options |
No |
string |
Responses
| Code |
Description |
| 200 |
returns an array of logMessages |
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
/api/logMessages/{id}
GET
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
id of logMessages |
Yes |
string |
Responses
PUT
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
id of logMessages |
Yes |
string |
Responses
| Code |
Description |
| 200 |
successful operation |
| 400 |
Error: Bad Request |
DELETE
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
id of logMessages |
Yes |
string |
Responses
| Code |
Description |
| 204 |
Deleted |
| 400 |
Error: Bad Request |
/api/setAllChannelStates
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
/api/setAllOutputStates
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
/api/setChannelState
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
/api/setChannelOutputStateAndError
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
/api/clearBitrateArray
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |
/api/updateChannelBitrate
POST
Responses
| Code |
Description |
| 201 |
Created |
| 400 |
Error: Bad Request |