Skip to content
Olivares AI docs

The module catalog and, for each module, whether it is selected, running, always-on, holds data, and who keeps it on

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

Returns the module catalog with, for each module, whether it is selected, running, always-on, holds data in this installation, and which modules require it, keep it on, or activate it.

Authorizations

Section titled “ Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
modules
required
Array<object>
object
activated_by

The active edition add-ons that run it although it may not be selected.

Array<string>
always_on

The engine cannot run without it; it cannot be deselected.

boolean
holds_data

Its tables hold rows in this installation. A module that is not running keeps that data, but nothing acts on it.

boolean
name
required
string
required_by

The running modules that keep it on although it is not selected.

Array<string>
requires
Array<string>
running
required

It runs on this node now (selected, required, or always on).

boolean
selected
required

The administrator chose it.

boolean
restarting

The engine is restarting itself to apply the change.

boolean
running_sessions
required

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

integer
Example generated 
{
  "modules": [
    {
      "activated_by": [
        "example"
      ],
      "always_on": true,
      "holds_data": true,
      "name": "example",
      "required_by": [
        "example"
      ],
      "requires": [
        "example"
      ],
      "running": true,
      "selected": true
    }
  ],
  "restarting": true,
  "running_sessions": 1
}

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"
  }
}