Skip to content
Olivares AI docs

The edition's activation view: current edition and preset, each add-on's state and each preset's add-on keys

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

Returns the edition’s activation view: current edition and preset, each add-on’s state (active, pending, available or console) with its family and its in-build and licence-covered facts, each preset’s add-on keys for the chooser, and the families an administrator turns on or off as a whole.

Authorizations

Section titled “ Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
addons
required
Array<object>
object
env
required
string
family

The key of the family that sells the add-on.

string
in_build

The edition’s catalog has the add-on. Absent means not known; false is an observed absence.

boolean
key
required
string
license_covered

The verified licence covers it. Absent means not known; false is an observed absence.

boolean
needs_secret
boolean
preset
required
string
reason
string
state
required
string
Allowed values: active pending available console
summary
required
string
title
required
string
edition
required
string
families

The groups the edition sells add-ons in; each is turned on or off as a whole.

Array<object>
object
active
required

The add-ons of the family that are on now.

Array<string>
addons
required
Array<string>
key
required
string
title
required
string
preset
string
presets
required
Array<object>
object
addons
required
Array<string>
name
required
string
restart_required
required

A change already applied still needs an engine restart to take effect; false when the running engine follows it.

boolean
restarting
boolean
Example 
{
  "addons": [
    {
      "state": "active"
    }
  ]
}

400

Section titled “ 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

Section titled “ 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

Section titled “ 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

Section titled “ 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

Section titled “ 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

Section titled “ 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"
  }
}