Skip to main content

Management APIs

LLM GATEWAY / MANAGEMENT V1

Configure your gateway.
Keep every change intentional.

Manage apps, shared providers, access keys and policy from one tenant-scoped API. Start with a workflow, then explore every request field.

Tenant-bound keys Explicit scopes Central configuration

Use a dedicated management key to configure the LLM Gateway from deployment pipelines, internal tools and administration scripts. Each key belongs to one tenant, carries explicit permissions, and works only when both deployment enablement and tenant opt-in are active.

Use the Management API to configure LLM Gateway apps, shared providers, credentials and policy. Explore complete input specifications and examples, or download the OpenAPI reference.

Choose a resource

The management model

Enable
Deployment switch
Tenant opt-in
Authorize
One tenant per key
Explicit scopes
Configure
Central management API
Validated changes
Apply
Gateway configuration sync
Policy-aware runtime
QuilrAI
ResourceWhat you can doWhat stays separate
AppsCreate, read, configure, disable and enable; address by app name.No app deletion or rename.
Shared providersCreate, read, rotate credentials, configure models, disable, enable and explicitly test.No provider deletion. Detaching affects one app only.
Gateway keysIssue, list metadata, change expiry, reveal with a dedicated scope and revoke.Management keys are a different credential type.
QuilrQLDiscover, preview, validate, simulate, draft, publish, enable, disable and roll back.App settings do not automatically publish policy.
Prompt StoreList, read, create, replace and delete app prompts.Prompt content and policy enforcement are distinct.
Smart groups and custom definitionsRead and use existing resources in app or policy configuration.No definition or membership editing.
HistoryRead redacted config versions and audit, restore eligible app settings.Traffic logs, usage, health and red-team jobs are outside v1.

Defaults

  • Management keys have no expiry by default. An administrator can supply one.
  • Creating an app issues one gateway key, named Default unless specified.
  • Disabling tenant management suspends its keys. Unexpired, unrevoked keys work again when the tenant is re-enabled.
  • Disabling an app preserves its keys, settings and history. Disabling a shared provider preserves its attachments.
  • Provider saves validate locally. A connection/model test is a separate explicit request.
  • Configuration writes go to the central management service. Customer gateway nodes receive synchronized changes.
Policy authority

When QuilrQL is enabled, updates to governed app settings still save. The response identifies the fields that remain inactive until QuilrQL authority is disabled. Use policy simulation to evaluate request-specific behavior.

Find an endpoint

Search by resource, path, action or HTTP method. Open an endpoint to see its scopes, parameters, complete body schema and examples.

57 of 57 operations

GET
/capabilitiesRead capabilities
GET
/appsList apps
POST
/appsCreate an app
GET
/apps/{app_name}Read an app
PATCH
/apps/{app_name}Update or disable an app
GET
/apps/{app_name}/providersList app providers
PUT
/apps/{app_name}/providers/{label}Attach a shared provider
DELETE
/apps/{app_name}/providers/{label}Detach an app provider
POST
/apps/{app_name}/provider-conversionConvert inline providers
GET
/providersList shared providers
POST
/providersCreate a shared provider
GET
/providers/{label}Read a shared provider
PATCH
/providers/{label}Update or disable a provider
POST
/providers/{label}/testTest connection or model
GET
/apps/{app_name}/keysList gateway credentials
POST
/apps/{app_name}/keysIssue a gateway credential
PATCH
/apps/{app_name}/keys/{key_id}Change gateway key expiry
DELETE
/apps/{app_name}/keys/{key_id}Revoke a gateway credential
POST
/apps/{app_name}/keys/{key_id}/revealReveal a gateway credential
GET
/apps/{app_name}/promptsList prompts
GET
/apps/{app_name}/prompts/{prompt_id}Read a prompt
PUT
/apps/{app_name}/prompts/{prompt_id}Create or replace a prompt
DELETE
/apps/{app_name}/prompts/{prompt_id}Delete a prompt
GET
/smart-groupsList smart groups
GET
/smart-groups/{group_name}Read a smart group
GET
/custom-definitionsList custom definitions
GET
/custom-definitions/{definition_id}Read a custom definition
GET
/apps/{app_name}/versionsList app configuration versions
GET
/apps/{app_name}/versions/{version_id}Read a configuration version
POST
/apps/{app_name}/versions/{version_id}/rollbackRoll back app configuration
GET
/audit-eventsRead configuration audit
GET
/policy/statusRead policy authority
GET
/policy/metadataRead policy metadata
GET
/policy/authoring-schemaRead policy authoring schema
GET
/policy/authoring-catalogRead policy authoring catalog
GET
/policy/suggested-policiesRead suggested policies
GET
/policy/authoring-catalog/searchSearch policy values
POST
/policy/conversion-previewPreview policy conversion
POST
/policy/validateValidate policy source
POST
/policy/simulateSimulate policy source
GET
/policy/draftsList policy drafts
POST
/policy/draftsCreate a policy draft
GET
/policy/drafts/{draft_id}Read a policy draft
PUT
/policy/drafts/{draft_id}Replace a policy draft
POST
/policy/drafts/{draft_id}/publishPublish a policy draft
GET
/policy/revisionsList policy revisions
GET
/policy/revisions/{revision}Read policy revision metadata
GET
/policy/revisions/{revision}/sourceRead policy revision source
POST
/policy/revisions/{revision}/rollbackRoll back policy authority
POST
/policy/enableEnable policy authority
POST
/policy/disableDisable policy authority
GET
/admin/tenants/{tenant_id}/settingsRead tenant management settings
PATCH
/admin/tenants/{tenant_id}/settingsEnable or suspend tenant management
GET
/admin/tenants/{tenant_id}/keysList management keys
POST
/admin/tenants/{tenant_id}/keysIssue a management key
PATCH
/admin/tenants/{tenant_id}/keys/{key_id}Update a management key
DELETE
/admin/tenants/{tenant_id}/keys/{key_id}Revoke a management key

Continue

Start with the end-to-end example, inspect the full app configuration schema, or review errors, concurrency and retry semantics. Download the OpenAPI 3.1 reference for all operations and input schemas.