Openminds Sock API

List Events

When resources are created, changed or destroyed in Sock, events are triggered to synchronize the server. This API endpoint returns a list of the pending, running and failed events of a selected resource.

When the server is fully synchronized with Sock, this list is empty.

If one or more events are returned, they have not yet been successfully applied on the server and you may need to wait for your changes to take effect. Failed events automatically notify the support team.

It is also possible to get all pending events without the resource scope.

URL

• /accounts/:id/events
• /applications/:id/events
• /databases/:id/events
• /ftp_users/:id/events
• /ssh_keys/:id/events
• /events

Method

GET

Data parameters

Required

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

Sample usage

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

Sample response

[
  {
    "id": 197,
    "receiver": "project-002.testclient",
    "sender": "exampleapp5",
    "state": "pending"
  }
]

Possible states

• pending: this change is still queued and waiting for other changes to finish first.
• running: this change is currently being applied on the server.
• failed: this change has failed and the support team has been automatically notified.