Control Panel — API documentation

Push Controls

Push controls object

Push controls allow manually connecting or disconnecting a push. Use a post with the action parameter set as needed.

Descriptions

name String Immutable Required

Push Name

String

Sample value:mypushpublish

success Boolean Autogenerated

Shows if the operation was successful

Sample value:1

primary Array Autogenerated

Shows the result from the primary

backup Array Autogenerated

Shows the result from the backup

option:server String

Override which server to send to.

Enum:primary, backup

Sample value:backup

action String Normal Required

Action to perform on the stream. Choices:

Enum:push_connect, push_disconnect

Sample value:push_connect

None

Examples

You cannot read the push_controls endpoint.

You cannot update the push_controls endpoint.

Update the Push_controls object with id mypushpublish.

Example URL

https://api.scaleengine.net/v2/push_controls/mypushpublish

Example cURL

curl -X POST --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/push_controls/mypushpublish

Example request body

{
    "action": "push_connect"
}

Example response data

{
    "name": "mypushpublish",
    "success": true,
    "primary": null,
    "backup": null
}

You cannot delete the push_controls endpoint.

Errors

ACCESS_VIOLATION

You do not have access to modify this field

REQUIRED_FIELD

Missing one or more required fields

TYPE_MISMATCH

Data type does not conform to required field type

MAX_LENGTH_EXCEEDED

The value exceeded maximum length allowed