---
title: "Admin API"
description: "All 55 control-plane operations generated from the accepted Admin OpenAPI contract."
---

> Documentation Index
> Fetch the complete documentation index at: https://nexus.microvoid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Admin API

The Admin API exposes **55 generated operations**. Every request uses a Management Key; only operations whose contract declares `Idempotency-Key` require it.

- <a href="https://nexus.microvoid.io/api/openapi/admin.openapi.json" download>
    Download the Admin OpenAPI document
  </a>
- [Management SDK](/management-sdk)

## Workspaces

- [Archive a workspace](/api-reference/admin/workspaces/archive-workspace) — `DELETE /admin/v1/workspaces/{workspaceId}`
- [Create a workspace](/api-reference/admin/workspaces/create-workspace) — `POST /admin/v1/workspaces`
- [Get a workspace](/api-reference/admin/workspaces/get-workspace) — `GET /admin/v1/workspaces/{workspaceId}`
- [List workspaces visible to the current management principal](/api-reference/admin/workspaces/list-workspaces) — `GET /admin/v1/workspaces`
- [Update a workspace](/api-reference/admin/workspaces/update-workspace) — `PATCH /admin/v1/workspaces/{workspaceId}`

## Provider Connections

- [Archive a provider connection](/api-reference/admin/provider-connections/archive-provider-connection) — `DELETE /admin/v1/provider-connections/{providerConnectionId}`
- [Connect an upstream provider and encrypted API key](/api-reference/admin/provider-connections/create-provider-connection) — `POST /admin/v1/workspaces/{workspaceId}/provider-connections`
- [Get a provider connection without secret plaintext](/api-reference/admin/provider-connections/get-provider-connection) — `GET /admin/v1/provider-connections/{providerConnectionId}`
- [List provider connections](/api-reference/admin/provider-connections/list-provider-connections) — `GET /admin/v1/workspaces/{workspaceId}/provider-connections`
- [Rotate a provider API key](/api-reference/admin/provider-connections/rotate-provider-secret) — `POST /admin/v1/provider-connections/{providerConnectionId}/rotate-secret`
- [Test provider connectivity and credentials before saving](/api-reference/admin/provider-connections/test-provider-connection) — `POST /admin/v1/workspaces/{workspaceId}/provider-connections/test`
- [Update a provider connection](/api-reference/admin/provider-connections/update-provider-connection) — `PATCH /admin/v1/provider-connections/{providerConnectionId}`
- [Verify provider connectivity and credentials](/api-reference/admin/provider-connections/verify-provider-connection) — `POST /admin/v1/provider-connections/{providerConnectionId}/verify`

## Plans and Strategies

- [Bind a strategy version to a plan from an effective time](/api-reference/admin/plans-and-strategies/bind-plan-strategy) — `POST /admin/v1/plans/{planId}/strategy-bindings`
- [Close a strategy binding at the requested effective time](/api-reference/admin/plans-and-strategies/close-plan-strategy-binding) — `DELETE /admin/v1/plan-strategy-bindings/{bindingId}`
- [Create a workspace plan](/api-reference/admin/plans-and-strategies/create-plan) — `POST /admin/v1/workspaces/{workspaceId}/plans`
- [Create a versioned quota strategy](/api-reference/admin/plans-and-strategies/create-quota-strategy) — `POST /admin/v1/workspaces/{workspaceId}/plan-strategies/quota`
- [Get a workspace plan and active strategy bindings](/api-reference/admin/plans-and-strategies/get-plan) — `GET /admin/v1/plans/{planId}`
- [Get a strategy version](/api-reference/admin/plans-and-strategies/get-plan-strategy) — `GET /admin/v1/plan-strategies/{strategyId}`
- [List workspace plans](/api-reference/admin/plans-and-strategies/list-plans) — `GET /admin/v1/workspaces/{workspaceId}/plans`
- [List plan strategies owned by a workspace](/api-reference/admin/plans-and-strategies/list-plan-strategies) — `GET /admin/v1/workspaces/{workspaceId}/plan-strategies`
- [List current and historical strategy bindings](/api-reference/admin/plans-and-strategies/list-plan-strategy-bindings) — `GET /admin/v1/plans/{planId}/strategy-bindings`
- [Publish a plan after strategy validation](/api-reference/admin/plans-and-strategies/publish-plan) — `POST /admin/v1/plans/{planId}/publish`
- [Publish an immutable strategy version](/api-reference/admin/plans-and-strategies/publish-plan-strategy) — `POST /admin/v1/plan-strategies/{strategyId}/publish`
- [Update a draft workspace plan](/api-reference/admin/plans-and-strategies/update-plan) — `PATCH /admin/v1/plans/{planId}`

## Users and Access

- [Activate a workspace access](/api-reference/admin/users-and-access/activate-workspace-access) — `POST /admin/v1/workspace-accesses/{accessId}/activate`
- [Change the plan bound to an access](/api-reference/admin/users-and-access/change-access-plan) — `PATCH /admin/v1/workspace-accesses/{accessId}/plan`
- [Get a workspace access](/api-reference/admin/users-and-access/get-workspace-access) — `GET /admin/v1/workspace-accesses/{accessId}`
- [List users with data-plane access to a workspace](/api-reference/admin/users-and-access/list-workspace-users) — `GET /admin/v1/workspaces/{workspaceId}/users`
- [Idempotently provision a Better Auth user and workspace access](/api-reference/admin/users-and-access/provision-workspace-user) — `POST /admin/v1/workspaces/{workspaceId}/users`
- [Renew access and create the next quota period from active plan strategies](/api-reference/admin/users-and-access/renew-workspace-access) — `POST /admin/v1/workspace-accesses/{accessId}/renew`
- [Suspend new data-plane calls](/api-reference/admin/users-and-access/suspend-workspace-access) — `POST /admin/v1/workspace-accesses/{accessId}/suspend`

## Inference Keys

- [Issue a Better Auth inference key; plaintext is returned once](/api-reference/admin/inference-keys/create-inference-key) — `POST /admin/v1/workspace-accesses/{accessId}/api-keys`
- [List inference keys without plaintext](/api-reference/admin/inference-keys/list-inference-keys) — `GET /admin/v1/workspace-accesses/{accessId}/api-keys`
- [Revoke an inference key without changing plan or quota](/api-reference/admin/inference-keys/revoke-inference-key) — `DELETE /admin/v1/workspace-accesses/{accessId}/api-keys/{keyId}`

## Quota

- [Get the current quota snapshot](/api-reference/admin/quota/get-workspace-access-quota) — `GET /admin/v1/workspace-accesses/{accessId}/quota`

## Usage and Audit

- [Get an invocation, provider attempt and quota settlement](/api-reference/admin/usage-and-audit/get-invocation) — `GET /admin/v1/invocations/{invocationId}`
- [List control-plane audit logs](/api-reference/admin/usage-and-audit/list-audit-logs) — `GET /admin/v1/workspaces/{workspaceId}/audit-logs`
- [List model invocations](/api-reference/admin/usage-and-audit/list-invocations) — `GET /admin/v1/workspaces/{workspaceId}/invocations`
- [List immutable usage and adjustment events](/api-reference/admin/usage-and-audit/list-usage-events) — `GET /admin/v1/workspaces/{workspaceId}/usage-events`

## Billing

- [Store or rotate a billing provider credential](/api-reference/admin/billing/configure-billing-provider-credential) — `PUT /admin/v1/billing-connections/{connectionId}/provider-credential`
- [Store or rotate a billing webhook signing secret](/api-reference/admin/billing/configure-billing-webhook-secret) — `PUT /admin/v1/billing-connections/{connectionId}/webhook-secret`
- [Create a Stripe, Creem or app-sync connection](/api-reference/admin/billing/create-billing-connection) — `POST /admin/v1/workspaces/{workspaceId}/billing-connections`
- [Map an external Product/Price to a workspace plan](/api-reference/admin/billing/create-billing-product-mapping) — `POST /admin/v1/billing-connections/{connectionId}/product-mappings`
- [Create a provider-neutral hosted subscription Checkout](/api-reference/admin/billing/create-checkout) — `POST /admin/v1/workspace-accesses/{accessId}/billing-checkouts`
- [Disable a product mapping](/api-reference/admin/billing/delete-billing-product-mapping) — `DELETE /admin/v1/billing-product-mappings/{mappingId}`
- [Disable a billing connection](/api-reference/admin/billing/disable-billing-connection) — `DELETE /admin/v1/billing-connections/{connectionId}`
- [List billing connections](/api-reference/admin/billing/list-billing-connections) — `GET /admin/v1/workspaces/{workspaceId}/billing-connections`
- [List product mappings](/api-reference/admin/billing/list-billing-product-mappings) — `GET /admin/v1/billing-connections/{connectionId}/product-mappings`
- [List webhook inbox events](/api-reference/admin/billing/list-billing-webhook-events) — `GET /admin/v1/billing-connections/{connectionId}/webhook-events`
- [List external subscription projections](/api-reference/admin/billing/list-external-subscriptions) — `GET /admin/v1/workspace-accesses/{accessId}/external-subscriptions`
- [Start external subscription reconciliation](/api-reference/admin/billing/reconcile-billing-connection) — `POST /admin/v1/billing-connections/{connectionId}/reconcile`
- [Replay a failed webhook inbox event](/api-reference/admin/billing/replay-billing-webhook-event) — `POST /admin/v1/webhook-events/{eventId}/replay`
- [Idempotently synchronize an external billing period](/api-reference/admin/billing/sync-workspace-access-billing-period) — `POST /admin/v1/workspace-accesses/{accessId}/billing-periods/sync`
- [Verify billing provider credentials](/api-reference/admin/billing/verify-billing-connection) — `POST /admin/v1/billing-connections/{connectionId}/verify`

Source: https://nexus.microvoid.io/api-reference/admin/index.mdx