Server version, engine, setup state and license status

GET

/v1/server-info

curl --request GET \
  --url https://example.com/v1/server-info

• this engine

Returns the non-sensitive server facts: version, engine, whether first-run setup is still required, and the informational license status.

Authorizations

• None

Responses

200

OK

Media type application/json

object

communication_ready

boolean

edition

string

engine

required

string

invite_delivery_unavailable

The engine cannot mail invitations (OLIVARES_INVITE_MAIL_DESTINATION with a declared console address): onboarding in invite mode answers 409 invite_delivery_unavailable. Absent when invitations are mailed.

boolean

jobs_not_running

Background jobs this node does not run, and why. Absent when every job runs.

Array<object>

object

job

required

string

Allowed values: retention legal_hold_archive audit_checkpoints audit_archive directory_synchronization

reason

required

string

Allowed values: no_tenant_inventory addon_requires_license directory_unavailable

license

object

licensee

string

plan

string

status

string

support_profile

string

support_tier

string

modules_not_enabled

Array<string>

previews_hidden

A new installation’s console navigation lists the first job only; every other page keeps its address. Absent on an installation that existed before.

boolean

protocol_currency

object

a2a_security_scheme_enforced

boolean

a2a_version

string

aaif_standards

Array<string>

agents_md_enforce_available

boolean

mcp_revision

string

mcp_revision_status

string

setup_required

required

boolean

sso_providers

Array<object>

object

label

required

string

start_url

required

string

tls_pin_sha256

The –pin-sha256 value of the certificate this engine serves (base64 SHA-256 of its SubjectPublicKeyInfo). Absent when the engine serves plain HTTP.

string

version

required

string

Example

{
  "jobs_not_running": [
    {
      "job": "retention",
      "reason": "no_tenant_inventory"
    }
  ]
}

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