Logo
OpenScaler

SSE operation progress stream

GET
/v1/events/{action_type}/{sequence_id}

Server-sent events (SSE) stream for long-running create operations.

Subscribe with a matching action_type and the client-supplied sequence_id from the create request body. Open this stream before or while calling create. Progress events are named progress. The stream ends when the backend signals completion. The create POST itself returns the created resource as JSON.

Authorization

bearer_auth
AuthorizationBearer <token>

OAuth Authentication

OpenScaler API uses OAuth, a standard for secure authorization. To access the API, obtain a token via the OpenScaler Platform.

Use the access_token in the Authorization header for requests:

Authorization: Bearer <token>

Always keep your token secure and do not share it with anyone.

In: header

Path Parameters

action_type*string

Type of long-running operation to subscribe to.

Value in

  • "create-vm"
  • "create-k8s-cluster"
  • "create-load-balancer"
  • "create-elastic-server"
sequence_id*integer

Client-supplied sequence ID from the matching create request body.

Response Body

text/event-stream

application/json

text/pain

application/json

application/json

curl -X GET "https://example.com/v1/events/create-vm/0"
"string"
{  "errors": [    {      "message": "'vcpus' field must be an integer",      "field": "resource_id"    }  ]}
"Access denied"
{  "errors": [    {      "message": "User not initialized (missing required fields in token), please init user by sending POST request to `/v1/init` then refresh your token\n"    }  ]}
{  "errors": [    {      "message": "VM with ID 23 not found"    }  ]}