Control Panel — API documentation

Push Status

Push status object

Push status can be used to get information on the status of a push.

Descriptions

name String Autogenerated

Push name

Default:

Sample value:mypush

active Integer Autogenerated

Shows if the push is currently running

Default:0

Sample value:0

last_messages Array Autogenerated

List of messages from the push process

None
None
None

Examples

Get the Push_status object with id .

Example URL

https://api.scaleengine.net/dev/v2/push_status/

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/dev/v2/push_status/

Example request body

None

Example response data

{
    "name": "mypush",
    "active": 0,
    "last_messages": null
}

Create a new Push_status object.

Example URL

https://api.scaleengine.net/dev/v2/push_status

Example cURL

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

Example request body

None

Example response data

{
    "name": "mypush",
    "active": 0,
    "last_messages": null
}

Update the Push_status object with id .

Example URL

https://api.scaleengine.net/dev/v2/push_status/

Example cURL

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

Example request body

None

Example response data

{
    "name": "mypush",
    "active": 0,
    "last_messages": null
}

Delete the Push_status object with id .

Example URL

https://api.scaleengine.net/dev/v2/push_status/

Example cURL

curl -X DELETE --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/dev/v2/push_status/

Example request body


			
			

Example response data

None

Errors

ACCESS_VIOLATION

You do not have access to modify this field