AdminApiEndpoints
const AdminApiEndpoints: object;Every endpoint an admin API key can reach, with the rule that authorizes it. An endpoint missing
here can’t be reached with a key. Ids are <METHOD> <path>, with :param path segments named as
the app’s route folders name them.
Type Declaration
app
readonly app: object;Paths relative to /api/admin on the app.
app.DELETE /api-keys/:api_key_id
readonly "DELETE /api-keys/:api_key_id": AdminApiWorkspaceEndpointRule;app.DELETE /api-keys/current
readonly "DELETE /api-keys/current": AdminApiSelfEndpointRule = SELF_RULE;app.DELETE /projects/:project_id
readonly "DELETE /projects/:project_id": AdminApiProjectEndpointRule;app.DELETE /projects/:project_id/accounts/:account_id
readonly "DELETE /projects/:project_id/accounts/:account_id": AdminApiProjectEndpointRule;app.DELETE /projects/:project_id/billing-providers/:billing_provider_id
readonly "DELETE /projects/:project_id/billing-providers/:billing_provider_id": AdminApiProjectEndpointRule;app.DELETE /projects/:project_id/customers/:customer_id
readonly "DELETE /projects/:project_id/customers/:customer_id": AdminApiProjectEndpointRule;app.DELETE /projects/:project_id/products/:product_id
readonly "DELETE /projects/:project_id/products/:product_id": AdminApiProjectEndpointRule;app.DELETE /projects/:project_id/products/:product_id/accounts/:account_id
readonly "DELETE /projects/:project_id/products/:product_id/accounts/:account_id": AdminApiProjectEndpointRule;app.DELETE /projects/:project_id/products/:product_id/ratelimit
readonly "DELETE /projects/:project_id/products/:product_id/ratelimit": AdminApiProjectEndpointRule;app.DELETE /projects/:project_id/products/:product_id/ratelimit/:rate_limit_id
readonly "DELETE /projects/:project_id/products/:product_id/ratelimit/:rate_limit_id": AdminApiProjectEndpointRule;app.DELETE /projects/:project_id/products/:product_id/usagelimit
readonly "DELETE /projects/:project_id/products/:product_id/usagelimit": AdminApiProjectEndpointRule;app.DELETE /projects/:project_id/products/:product_id/usagelimit/:usage_limit_id
readonly "DELETE /projects/:project_id/products/:product_id/usagelimit/:usage_limit_id": AdminApiProjectEndpointRule;app.DELETE /secrets-integrations/:integration_id
readonly "DELETE /secrets-integrations/:integration_id": AdminApiWorkspaceEndpointRule;app.DELETE /subscription-relays/:relay_id
readonly "DELETE /subscription-relays/:relay_id": AdminApiWorkspaceEndpointRule;app.GET /api-keys
readonly "GET /api-keys": AdminApiWorkspaceEndpointRule;app.GET /api-keys/:api_key_id
readonly "GET /api-keys/:api_key_id": AdminApiWorkspaceEndpointRule;app.GET /api-keys/current
readonly "GET /api-keys/current": AdminApiSelfEndpointRule = SELF_RULE;app.GET /backups/export
readonly "GET /backups/export": AdminApiWorkspaceEndpointRule;app.GET /projects
readonly "GET /projects": AdminApiProjectListEndpointRule;app.GET /projects/:project_id
readonly "GET /projects/:project_id": AdminApiProjectEndpointRule;app.GET /projects/:project_id/accounts
readonly "GET /projects/:project_id/accounts": AdminApiProjectEndpointRule;app.GET /projects/:project_id/accounts/:account_id
readonly "GET /projects/:project_id/accounts/:account_id": AdminApiProjectEndpointRule;app.GET /projects/:project_id/backups/export
readonly "GET /projects/:project_id/backups/export": AdminApiProjectEndpointRule;app.GET /projects/:project_id/customers
readonly "GET /projects/:project_id/customers": AdminApiProjectEndpointRule;app.GET /projects/:project_id/customers/:customer_id
readonly "GET /projects/:project_id/customers/:customer_id": AdminApiProjectEndpointRule;app.GET /projects/:project_id/products
readonly "GET /projects/:project_id/products": AdminApiProjectEndpointRule;app.GET /projects/:project_id/products/:product_id
readonly "GET /projects/:project_id/products/:product_id": AdminApiProjectEndpointRule;app.GET /projects/:project_id/products/:product_id/ratelimit
readonly "GET /projects/:project_id/products/:product_id/ratelimit": AdminApiProjectEndpointRule;app.GET /projects/:project_id/products/:product_id/ratelimit/:rate_limit_id
readonly "GET /projects/:project_id/products/:product_id/ratelimit/:rate_limit_id": AdminApiProjectEndpointRule;app.GET /projects/:project_id/products/:product_id/usagelimit
readonly "GET /projects/:project_id/products/:product_id/usagelimit": AdminApiProjectEndpointRule;app.GET /projects/:project_id/products/:product_id/usagelimit/:usage_limit_id
readonly "GET /projects/:project_id/products/:product_id/usagelimit/:usage_limit_id": AdminApiProjectEndpointRule;app.GET /secrets-integrations
readonly "GET /secrets-integrations": AdminApiWorkspaceEndpointRule;app.GET /secrets-integrations/:integration_id
readonly "GET /secrets-integrations/:integration_id": AdminApiWorkspaceEndpointRule;app.GET /secrets-integrations/:integration_id/items
readonly "GET /secrets-integrations/:integration_id/items": AdminApiWorkspaceEndpointRule;app.GET /secrets-integrations/:integration_id/vaults
readonly "GET /secrets-integrations/:integration_id/vaults": AdminApiWorkspaceEndpointRule;app.GET /starred-items
readonly "GET /starred-items": AdminApiWorkspaceEndpointRule;app.GET /subscription-relays
readonly "GET /subscription-relays": AdminApiWorkspaceEndpointRule;app.GET /subscription-relays/:relay_id/membership
readonly "GET /subscription-relays/:relay_id/membership": AdminApiWorkspaceEndpointRule;app.GET /subscription-signin
readonly "GET /subscription-signin": AdminApiWorkspaceEndpointRule;app.PATCH /api-keys/:api_key_id
readonly "PATCH /api-keys/:api_key_id": AdminApiSessionEndpointRule = SESSION_RULE;app.PATCH /projects/:project_id
readonly "PATCH /projects/:project_id": AdminApiProjectEndpointRule;app.PATCH /projects/:project_id/accounts/:account_id
readonly "PATCH /projects/:project_id/accounts/:account_id": AdminApiProjectEndpointRule;app.PATCH /projects/:project_id/billing-providers/:billing_provider_id
readonly "PATCH /projects/:project_id/billing-providers/:billing_provider_id": AdminApiProjectEndpointRule;app.PATCH /projects/:project_id/customers/:customer_id
readonly "PATCH /projects/:project_id/customers/:customer_id": AdminApiProjectEndpointRule;app.PATCH /projects/:project_id/products/:product_id
readonly "PATCH /projects/:project_id/products/:product_id": AdminApiProjectEndpointRule;app.PATCH /projects/:project_id/products/:product_id/ratelimit/:rate_limit_id
readonly "PATCH /projects/:project_id/products/:product_id/ratelimit/:rate_limit_id": AdminApiProjectEndpointRule;app.PATCH /projects/:project_id/products/:product_id/usagelimit/:usage_limit_id
readonly "PATCH /projects/:project_id/products/:product_id/usagelimit/:usage_limit_id": AdminApiProjectEndpointRule;app.PATCH /starred-items
readonly "PATCH /starred-items": AdminApiWorkspaceEndpointRule;app.PATCH /subscription-relays/:relay_id/membership
readonly "PATCH /subscription-relays/:relay_id/membership": AdminApiWorkspaceEndpointRule;app.POST /api-keys
readonly "POST /api-keys": AdminApiSessionEndpointRule = SESSION_RULE;app.POST /api-keys/:api_key_id/rotate
readonly "POST /api-keys/:api_key_id/rotate": AdminApiSessionEndpointRule = SESSION_RULE;app.POST /api-keys/current/rotate
readonly "POST /api-keys/current/rotate": AdminApiSelfEndpointRule = SELF_RULE;app.POST /backups/import
readonly "POST /backups/import": AdminApiWorkspaceEndpointRule;app.POST /backups/import/plan
readonly "POST /backups/import/plan": AdminApiWorkspaceEndpointRule;app.POST /backups/plan
readonly "POST /backups/plan": AdminApiWorkspaceEndpointRule;app.POST /backups/restore
readonly "POST /backups/restore": AdminApiWorkspaceEndpointRule;app.POST /projects
readonly "POST /projects": AdminApiNewProjectEndpointRule;app.POST /projects/:project_id/accounts
readonly "POST /projects/:project_id/accounts": AdminApiProjectEndpointRule;app.POST /projects/:project_id/backups/plan
readonly "POST /projects/:project_id/backups/plan": AdminApiProjectEndpointRule;app.POST /projects/:project_id/backups/restore
readonly "POST /projects/:project_id/backups/restore": AdminApiProjectEndpointRule;app.POST /projects/:project_id/billing-providers
readonly "POST /projects/:project_id/billing-providers": AdminApiProjectEndpointRule;app.POST /projects/:project_id/customers
readonly "POST /projects/:project_id/customers": AdminApiProjectEndpointRule;app.POST /projects/:project_id/customers/:customer_id/product-grants
readonly "POST /projects/:project_id/customers/:customer_id/product-grants": AdminApiProjectEndpointRule;app.POST /projects/:project_id/customers/native/login
readonly "POST /projects/:project_id/customers/native/login": AdminApiProjectEndpointRule;app.POST /projects/:project_id/customers/native/register
readonly "POST /projects/:project_id/customers/native/register": AdminApiProjectEndpointRule;app.POST /projects/:project_id/firebase/lifecycle
readonly "POST /projects/:project_id/firebase/lifecycle": AdminApiProjectEndpointRule;app.POST /projects/:project_id/products
readonly "POST /projects/:project_id/products": AdminApiProjectEndpointRule;app.POST /projects/:project_id/products/:product_id/accounts/:account_id
readonly "POST /projects/:project_id/products/:product_id/accounts/:account_id": AdminApiProjectEndpointRule;app.POST /projects/:project_id/products/:product_id/ratelimit
readonly "POST /projects/:project_id/products/:product_id/ratelimit": AdminApiProjectEndpointRule;app.POST /projects/:project_id/products/:product_id/usagelimit
readonly "POST /projects/:project_id/products/:product_id/usagelimit": AdminApiProjectEndpointRule;app.POST /secrets-integrations
readonly "POST /secrets-integrations": AdminApiWorkspaceEndpointRule;app.POST /secrets-integrations/:integration_id/sync
readonly "POST /secrets-integrations/:integration_id/sync": AdminApiWorkspaceEndpointRule;app.POST /subscription-relays
readonly "POST /subscription-relays": AdminApiWorkspaceEndpointRule;app.POST /subscription-signin/:sign_in_id/account
readonly "POST /subscription-signin/:sign_in_id/account": AdminApiWorkspaceEndpointRule;app.POST /subscription-signin/:sign_in_id/chat
readonly "POST /subscription-signin/:sign_in_id/chat": AdminApiWorkspaceEndpointRule;app.POST /subscription-signin/claude-quota
readonly "POST /subscription-signin/claude-quota": AdminApiWorkspaceEndpointRule;app.POST /subscription-signin/import
readonly "POST /subscription-signin/import": AdminApiWorkspaceEndpointRule;app.POST /subscription-signin/import-codex
readonly "POST /subscription-signin/import-codex": AdminApiWorkspaceEndpointRule;gateway
readonly gateway: object;Paths on the gateway.
gateway.GET /v1/logger
readonly "GET /v1/logger": AdminApiProjectEndpointRule;Last updated on