Control Panel — API documentation

Please provide a valid credit card using the credit card form on the billing page. Update Card Details

Stream Fetch Controls

Stream fetch controls object

Stream Fetch controls object can be used to perform actions on a given stream fetch.

Descriptions

name String Immutable Required

Stream Name

May only contain alpha numerical characters, dashes (-), and underscores (_)

Sample value:mystreamname

None
action String Normal Required

Action to perform on the stream. Choices: [reload, reset]

Sample value:reset

None

Examples

You cannot read a streamfetch_controls endpoint.

You cannot update a streamfetch_controls endpoint.

Update the Streamfetch_controls object with id mystreamname.

Example URL

https://api.scaleengine.net/dev/v2/streamfetch_controls/mystreamname

Example cURL

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

Example request body

{
    "action": "reset"
}

Example response data

{
    "name": "mystreamname"
}

You cannot delete a streamfetch_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

STREAM_INVALID

May only contain alpha numerical characters, dashes (-), and underscores (_)