ScaleEngine Control Panel

Streamfetch Status

Streamfetch status object

Streamfetch status can be used to get information on the status of a streamfetch.

Descriptions

Fields Filters Parameters Related Objects

stream String Immutable Required

Stream Name

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

Sample value:mystreamname

running Boolean Autogenerated

Shows whether the streamfetch is publishing the stream

Sample value:1

flapping Boolean Autogenerated

Shows whether the streamfetch is unable to pull the stream and retrying

Sample value:

started String Autogenerated

Timestamp of when the streamfetch started

Sample value:2021-08-27T17:41:07+0000

None

Examples

Read Create Update Delete

Get the Streamfetch_status object with id mystreamname.

Example URL

https://api.scaleengine.net/v2/streamfetch_status/mystreamname

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/streamfetch_status/mystreamname

Example request body

None

Example response data

{
    "stream": "mystreamname",
    "running": true,
    "flapping": false,
    "started": "2021-08-27T17:41:07+0000"
}

You cannot create a streamfetch_status endpoint.

You cannot update a streamfetch_status endpoint.

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