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