Skip to content
StratumStratum Docs

The install's progress, as server-sent events.

GET
/v1/installer/install/events
Code sample: Shell / cURL
curl --request GET \
  --url https://192.0.2.10:9443/v1/installer/install/events \
  --header 'Authorization: <Authorization>'

A text/event-stream of every event of every install attempt, in order: step (a step starts or ends), log (one line of the job’s output) and verdict (the attempt’s outcome). Each event’s id is its position in the stream, so a client that reconnects with Last-Event-ID (or after) resumes where it stopped, and one that connects without either gets the whole history replayed. The stream ends after the latest attempt’s verdict; before any install it stays open, sending a comment every 15 s, until one starts. Each data: line is one InstallEvent as JSON.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
after
integer format: int64

Send only events with a larger id.

Header Parameters

Section titled “Header Parameters”
Last-Event-ID
string

The SSE reconnect header; wins over after.

Responses

Section titled “Responses”

200

Section titled “200”

The event stream.

Media typetext/event-stream
string

400

Section titled “400”

The request is malformed.

Media typeapplication/problem+json

RFC 7807 problem details, the control plane’s shape.

object
type
required
string
title
required
string
status
required
integer
>= 400 <= 599
detail
string
code
required
string
requestId
required
string
errors

Field errors, for INVALID_CONFIG.

Array<object>
object
field
required

The structured field (network.floatingIpCidrs[1]); empty for the whole config. For a raw YAML draft, the node.yaml key.

string
message
required
string

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "requestId": "example",
  "errors": [
    {
      "field": "example",
      "message": "example"
    }
  ]
}

401

Section titled “401”

No install code, or the wrong one.

Media typeapplication/problem+json

RFC 7807 problem details, the control plane’s shape.

object
type
required
string
title
required
string
status
required
integer
>= 400 <= 599
detail
string
code
required
string
requestId
required
string
errors

Field errors, for INVALID_CONFIG.

Array<object>
object
field
required

The structured field (network.floatingIpCidrs[1]); empty for the whole config. For a raw YAML draft, the node.yaml key.

string
message
required
string

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "requestId": "example",
  "errors": [
    {
      "field": "example",
      "message": "example"
    }
  ]
}

429

Section titled “429”

Too many wrong install codes; wait for Retry-After.

Media typeapplication/problem+json

RFC 7807 problem details, the control plane’s shape.

object
type
required
string
title
required
string
status
required
integer
>= 400 <= 599
detail
string
code
required
string
requestId
required
string
errors

Field errors, for INVALID_CONFIG.

Array<object>
object
field
required

The structured field (network.floatingIpCidrs[1]); empty for the whole config. For a raw YAML draft, the node.yaml key.

string
message
required
string

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "requestId": "example",
  "errors": [
    {
      "field": "example",
      "message": "example"
    }
  ]
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds until the next attempt is considered.

500

Section titled “500”

The installer failed to answer.

Media typeapplication/problem+json

RFC 7807 problem details, the control plane’s shape.

object
type
required
string
title
required
string
status
required
integer
>= 400 <= 599
detail
string
code
required
string
requestId
required
string
errors

Field errors, for INVALID_CONFIG.

Array<object>
object
field
required

The structured field (network.floatingIpCidrs[1]); empty for the whole config. For a raw YAML draft, the node.yaml key.

string
message
required
string

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "requestId": "example",
  "errors": [
    {
      "field": "example",
      "message": "example"
    }
  ]
}