Admin HTTP API
Manage a Modem workspace: projects, products, customers, provider accounts, keys and backups.
Specification: OpenAPI 3.1.0; API version 1.0.0.
Download the OpenAPI document.
See the API guide for authentication, shared errors and complete workflows.
Operation pages show the parameters, bodies and response statuses declared by the source specification. A missing declaration does not establish that a runtime requirement or error response cannot exist.
Security schemes
{
"bearerAuth": {
"type": "http",
"scheme": "bearer"
}
}Operations
| Method | Path | Operation |
|---|---|---|
| POST | /api/authorize/token | Exchange an authorization code for an API key |
| GET | /api/admin/api-keys/current | Describe the API key making the request |
| DELETE | /api/admin/api-keys/current | Revoke the API key making the request |
| POST | /api/admin/api-keys/current/rotate | Give the API key making the request a new secret |
| GET | /api/admin/api-keys | List API keys |
| GET | /api/admin/api-keys/{apiKeyId} | Retrieve an API key |
| DELETE | /api/admin/api-keys/{apiKeyId} | Revoke an API key |
| GET | /api/admin/starred-items | List starred items |
| PATCH | /api/admin/starred-items | Add, move or remove a starred item |
| GET | /api/admin/projects | List projects |
| POST | /api/admin/projects | Create a project |
| GET | /api/admin/projects/{projectId} | Retrieve a project |
| PATCH | /api/admin/projects/{projectId} | Update a project |
| DELETE | /api/admin/projects/{projectId} | Delete a project |
| POST | /api/admin/projects/{projectId}/billing-providers | Enable an external billing provider |
| PATCH | /api/admin/projects/{projectId}/billing-providers/{billingProviderId} | Update an external billing provider |
| DELETE | /api/admin/projects/{projectId}/billing-providers/{billingProviderId} | Disconnect an external billing provider |
| GET | /api/admin/projects/{projectId}/accounts | List provider accounts |
| POST | /api/admin/projects/{projectId}/accounts | Create a provider account |
| GET | /api/admin/projects/{projectId}/accounts/{accountId} | Retrieve a provider account |
| PATCH | /api/admin/projects/{projectId}/accounts/{accountId} | Update a provider account |
| DELETE | /api/admin/projects/{projectId}/accounts/{accountId} | Delete a provider account |
| GET | /api/admin/secrets-integrations | List secrets integrations |
| POST | /api/admin/secrets-integrations | Create a secrets integration |
| GET | /api/admin/secrets-integrations/{integrationId} | Retrieve a secrets integration |
| DELETE | /api/admin/secrets-integrations/{integrationId} | Delete a secrets integration |
| POST | /api/admin/secrets-integrations/{integrationId}/sync | Refresh account and provider credential fields from a secrets integration |
| GET | /api/admin/secrets-integrations/{integrationId}/vaults | List a secrets integration’s vaults |
| GET | /api/admin/secrets-integrations/{integrationId}/items | List the items in a secrets integration’s vault |
| GET | /api/admin/subscription-signin | List subscription sign-ins |
| POST | /api/admin/subscription-signin/import | Import a coding-harness subscription sign-in |
| POST | /api/admin/subscription-signin/import-codex | Import an existing Codex ChatGPT sign-in |
| POST | /api/admin/subscription-signin/claude-quota | Report subscription quotas from a local Claude Code session |
| POST | /api/admin/subscription-signin/{signInId}/account | Read a subscription sign-in’s account, renewing its token if needed |
| POST | /api/admin/subscription-signin/{signInId}/chat | Chat with a subscription sign-in |
| GET | /api/admin/subscription-relays | List subscription relays |
| POST | /api/admin/subscription-relays | Create a subscription relay and return its key once |
| GET | /api/admin/subscription-relays/{relayId}/membership | Read ordered relay membership |
| PATCH | /api/admin/subscription-relays/{relayId}/membership | Replace ordered relay membership |
| DELETE | /api/admin/subscription-relays/{relayId} | Revoke a subscription relay |
| GET | /api/admin/projects/{projectId}/products | List products |
| POST | /api/admin/projects/{projectId}/products | Create a product |
| GET | /api/admin/projects/{projectId}/products/{productId} | Retrieve a product |
| PATCH | /api/admin/projects/{projectId}/products/{productId} | Update a product |
| DELETE | /api/admin/projects/{projectId}/products/{productId} | Delete a product |
| POST | /api/admin/projects/{projectId}/products/{productId}/accounts/{externalServiceAccountId} | Attach a provider account to a product |
| DELETE | /api/admin/projects/{projectId}/products/{productId}/accounts/{externalServiceAccountId} | Detach a provider account from a product |
| POST | /api/admin/projects/{projectId}/products/{productId}/usagelimit | Create a usage limit rule |
| GET | /api/admin/projects/{projectId}/products/{productId}/usagelimit | List usage limit rules |
| DELETE | /api/admin/projects/{projectId}/products/{productId}/usagelimit | Delete every usage limit rule of a product |
| GET | /api/admin/projects/{projectId}/products/{productId}/usagelimit/{usageLimitId} | Retrieve a usage limit rule |
| DELETE | /api/admin/projects/{projectId}/products/{productId}/usagelimit/{usageLimitId} | Delete a usage limit rule |
| PATCH | /api/admin/projects/{projectId}/products/{productId}/usagelimit/{usageLimitId} | Update a usage limit rule |
| POST | /api/admin/projects/{projectId}/products/{productId}/ratelimit | Create a rate limit rule |
| GET | /api/admin/projects/{projectId}/products/{productId}/ratelimit | List rate limit rules |
| DELETE | /api/admin/projects/{projectId}/products/{productId}/ratelimit | Delete every rate limit rule of a product |
| GET | /api/admin/projects/{projectId}/products/{productId}/ratelimit/{rateLimitId} | Retrieve a rate limit rule |
| DELETE | /api/admin/projects/{projectId}/products/{productId}/ratelimit/{rateLimitId} | Delete a rate limit rule |
| PATCH | /api/admin/projects/{projectId}/products/{productId}/ratelimit/{rateLimitId} | Update a rate limit rule |
| POST | /api/admin/projects/{projectId}/customers | Create a sandbox customer |
| GET | /api/admin/projects/{projectId}/customers | List customers |
| GET | /api/admin/projects/{projectId}/customers/{customerId} | Retrieve a customer |
| DELETE | /api/admin/projects/{projectId}/customers/{customerId} | Delete a customer |
| PATCH | /api/admin/projects/{projectId}/customers/{customerId} | Update a customer |
| POST | /api/admin/projects/{projectId}/customers/native/login | Log a customer in with native authentication |
| POST | /api/admin/projects/{projectId}/customers/native/register | Register a customer with native authentication |
| POST | /api/admin/projects/{projectId}/customers/{customerId}/product-grants | Grant a customer a product |
| POST | /api/admin/projects/{projectId}/firebase/lifecycle | Relay a Firebase Auth user deletion |
| GET | /api/admin/backups/export | Export a workspace backup |
| GET | /api/admin/projects/{projectId}/backups/export | Export a project backup |
| POST | /api/admin/backups/restore | Restore a workspace backup |
| POST | /api/admin/projects/{projectId}/backups/restore | Restore a project backup |
Last updated on