Openminds Sock API

Events status

When resources are created, changed or destroyed in Sock, events are triggered to synchronize the server. These events are processed by workers. This API endpoint provide a status check for these workers.

You can see three things via this endpoint:

1. If the workers are running or paused
2. The number of failed events
3. The number of pending and running events

URL

• /events/status

Method

GET

Data parameters

Required

• user_token=[string]
• client_token=[string]

Sample usage

curl -X GET https://sock.openminds.be/api/v1/events/status -d user_token=1234 -d client_token=5678

Sample response

"events": {
    "status": "running",
    "failed": 0,
    "pending": 4
}

Possible statuses

• running: all workers are online and processing your events.
• paused: the workers are currently paused; pending events will stay queued until the workers are running again. Openminds has been notified and will get them back running as soon as possible. I