Skip to content
Olivares AI docs

Overview

Olivares AI control plane API v1

Section titled “Olivares AI control plane API v1”

REST contract for the Olivares AI control plane. Authentication is an opaque bearer token (session olvs_… or API key olvk_…). Tenant is resolved from a bound token or the X-Olivares-Tenant header.

Information

  • License: AGPL-3.0-only
  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/healthz
GET
/livez
GET
/metrics
GET
/openapi.json
GET
/pod-readyz
GET
/readyz
GET
/status
GET
/v1/server-info
POST
/v1/auth/login
POST
/v1/auth/logout
POST
/v1/auth/refresh
GET
/v1/auth/whoami
POST
/v1/setup
GET
/v1/access-edges
GET
/v1/agents
POST
/v1/agents
GET
/v1/agents/{id}
DELETE
/v1/agents/{id}
PATCH
/v1/agents/{id}
GET
/v1/audit
GET
/v1/audit/export
GET
/v1/audit/pubkey
GET
/v1/audit/system
GET
/v1/audit/verify
GET
/v1/users
POST
/v1/users
GET
/v1/users/superadmins
POST
/v1/users/{id}/disable
POST
/v1/users/{id}/enable
GET
/v1/tokens
POST
/v1/tokens
DELETE
/v1/tokens/{id}
POST
/v1/tokens/{id}/rotate
GET
/v1/workspaces
POST
/v1/workspaces
GET
/v1/workspaces/{id}
PATCH
/v1/workspaces/{id}
GET
/v1/members
POST
/v1/memberships
GET
/v1/search
GET
/v1/system/orgs
POST
/v1/system/orgs
DELETE
/v1/system/orgs/{tenant_id}
PUT
/v1/system/orgs/{tenant_id}/region
PUT
/v1/system/orgs/{tenant_id}/status
GET
/v1/system/residency
GET
/v1/connectors/health
GET
/v1/console/bus
GET
/v1/console/config/effective
GET
/v1/console/connectors
PUT
/v1/console/connectors
DELETE
/v1/console/connectors
POST
/v1/console/connectors/test
GET
/v1/console/health-summary
GET
/v1/console/keys
GET
/v1/console/license
POST
/v1/console/license
DELETE
/v1/console/license
GET
/v1/console/secrets
PUT
/v1/console/secrets
DELETE
/v1/console/secrets
GET
/v1/console/setup-status
GET
/v1/console/sources
PUT
/v1/console/sources
DELETE
/v1/console/sources
GET
/v1/console/sso
PUT
/v1/console/sso
DELETE
/v1/console/sso
POST
/v1/console/sso/test
POST
/v1/console/support-bundle
POST
/v1/console/update-check

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth ”

Opaque session (olvs_) or API (olvk_) token.

Security scheme type: http