The running version, the newest signed release in the instance's channel with its notes, and whether it is newer

GET

/v1/console/updates

curl --request GET \
  --url https://example.com/v1/console/updates \
  --header 'Authorization: Bearer <token>'

• this engine

Checks the instance’s release channel now and returns the running version, the newest signed release with its notes and advisories, whether it is newer, and the sessions an update would stop; a channel that cannot be checked is reported in check_error with the running version still present.

Authorizations

• bearerAuth
• browserSession

Responses

200

OK

Media type application/json

object

advisories

Array<string>

available

The newest release in the channel, when the check reached it.

string

channel

string

check_error

Why the channel could not be checked, in the words olivares upgrade uses.

string

edition

required

string

Allowed values: community enterprise

edition_switch

Present on a Community build that holds a live Business or Enterprise license: the one next step to the licensed build for the way this engine was installed. The newest release above is then the licensed build.

object

command

The exact command for this installation; empty where the manifest does it.

string

console_action

required

The apply operation takes the step itself, so the console offers a button.

boolean

install

required

How this engine was installed.

string

Allowed values: binary container package kubernetes

then

required

What follows the command.

string

to

required

The edition the license entitles; both are one licensed build.

string

Allowed values: business enterprise

notes

string

released_at

string format: date-time

restart_required

A newer binary than the running one is already installed; the engine runs the old version until it restarts.

boolean

restarting

The engine is restarting itself on the new version.

boolean

running_sessions

required

Sessions this engine runs now. The restart that applies an update stops every one of them; each can be resumed.

integer

security

The release fixes a published advisory.

boolean

update_available

required

The newest release is newer than the running version.

boolean

version

required

The version this engine runs now; after an apply it stays the old one until the engine has restarted.

string

Example

{
  "edition": "community",
  "edition_switch": {
    "install": "binary",
    "to": "business"
  }
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}