> ## Documentation Index > Fetch the complete documentation index at: https://docs.akua.dev/llms.txt > Use this file to discover all available pages before exploring further. # Revoke a connection > Stops all use of the connection immediately and answers with state REVOKING. The provider is then asked to revoke and the stored credential is erased in the background, however long that takes, and the state becomes REVOKED. Grants on the connection stop applying at once. ## OpenAPI ````yaml /openapi-public.json post /connections/{id}:revoke openapi: 3.1.0 info: title: Akua API version: 1.0.0 description: >- Public API for managing Akua workspaces, clusters, products, and installs. Authenticate with a workspace API token via the `Authorization: Bearer sk_akua_...` header. A workspace-owned token implies its workspace. Broad tokens select the active workspace via the optional `Akua-Context` header. contact: name: Akua API support email: support@akua.dev url: https://akua.dev/docs servers: - url: https://api.akua.dev/v1 description: Production security: [] tags: - name: Auth description: Authentication and token management. - name: Custom domains description: Workspace custom domains and routing targets. - name: Cloudflare description: Cloudflare account credentials and gateway control. - name: Clusters description: Kubernetes clusters and cluster access operations. - name: ComputeConfigs description: Workspace compute provider configurations. - name: Entitlements description: Effective workspace capabilities and limits. - name: Dashboards description: Dashboard and widget resources. - name: Installs description: Installation and render operations. - name: Machines description: Compute machines and lifecycle events. - name: Notifications description: User notification state. - name: Offer Channels description: Private offer channels and policy versions. - name: Offers description: Marketplace offers and redemption tracking. - name: Operations description: Long-running operation status and controls. - name: Order Drafts description: Draft checkout orders and checkout sessions. - name: Organizations description: Organizations, memberships, and managed workspaces. - name: Packages description: Software packages, versions, and input schemas. - name: Products description: Marketplace product catalog resources. - name: Preview hostnames description: Install preview hostnames and routing state. - name: Quotas description: Workspace quota limits and usage. - name: Regions description: Available deployment regions. - name: Registry description: Container registry credentials and repositories. - name: Repository change requests description: Fork-backed repository change reviews and lifecycle actions. - name: Repositories description: Source repositories available to the workspace. - name: Secrets description: Workspace secrets and secret versions. - name: Snippets description: Reusable snippets and snippet runs. - name: Workspace subdomains description: Workspace subdomain identity. - name: Workspaces description: Workspace resources, members, and billing state. paths: /connections/{id}:revoke: post: tags: - Connections summary: Revoke a connection description: >- Stops all use of the connection immediately and answers with state REVOKING. The provider is then asked to revoke and the stored credential is erased in the background, however long that takes, and the state becomes REVOKED. Grants on the connection stop applying at once. operationId: connections.revoke parameters: - name: id in: path schema: $ref: '#/components/schemas/ConnectionId' required: true - name: akua-context in: header schema: type: string minLength: 1 maxLength: 53 description: >- Optional workspace/scope context for the request. Carries a single workspace wire id (`ws_…`) today. Only needed for broad tokens - a workspace-owned token implies its workspace. examples: - ws_j572abc123def456 required: false responses: '200': description: Connection content: application/json: schema: $ref: '#/components/schemas/Connection' '400': description: The request is malformed. content: application/json: schema: $ref: '#/components/schemas/ApiBadRequest' '401': description: Missing, invalid or expired credential. content: application/json: schema: $ref: '#/components/schemas/ApiUnauthorized' '403': description: The credential may not act in this workspace. content: application/json: schema: $ref: '#/components/schemas/ApiForbidden' '404': description: The resource was not found in this workspace. content: application/json: schema: $ref: '#/components/schemas/ApiNotFound' '409': description: >- The request conflicts with existing resource state or immutable intent. | The idempotency key was already used for a different request. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ApiConflict' - $ref: '#/components/schemas/ApiIdempotencyConflict' '503': description: The service is temporarily unavailable. content: application/json: schema: $ref: '#/components/schemas/ApiServiceUnavailable' security: - BearerAuth: [] components: schemas: ConnectionId: type: string pattern: ^conn_[^\s/]{1,64}$ title: ConnectionId description: A connection id examples: - conn_j572abc123def456 Connection: type: object properties: id: $ref: '#/components/schemas/ConnectionId' vault_id: $ref: '#/components/schemas/VaultId' connector: $ref: '#/components/schemas/ConnectorSlug' name: type: string minLength: 1 maxLength: 100 owner: $ref: '#/components/schemas/ConnectionOwner' state: $ref: '#/components/schemas/ConnectionState' created_at: type: integer description: Unix timestamp (seconds) minimum: 0 required: - id - vault_id - connector - name - owner - state - created_at additionalProperties: false ApiBadRequest: type: object properties: _tag: type: string enum: - Validation success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiUnauthorized: type: object properties: _tag: type: string enum: - Unauthorized success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiForbidden: type: object properties: _tag: type: string enum: - Forbidden success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiNotFound: type: object properties: _tag: type: string enum: - NotFound success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiConflict: type: object properties: _tag: type: string enum: - Conflict success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiIdempotencyConflict: type: object properties: _tag: type: string enum: - IdempotencyConflict success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiServiceUnavailable: type: object properties: _tag: type: string enum: - ServiceUnavailable success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false VaultId: type: string pattern: ^vlt_[^\s/]{1,64}$ title: VaultId description: A vault id examples: - vlt_j572abc123def456 ConnectorSlug: type: string pattern: ^[a-z0-9][a-z0-9_-]{0,63}$ title: ConnectorSlug description: A connector's stable slug. examples: - openai ConnectionOwner: anyOf: - type: object properties: type: type: string enum: - workspace required: - type additionalProperties: false - type: object properties: type: type: string enum: - user user_id: type: string required: - type - user_id additionalProperties: false - type: object properties: type: type: string enum: - external_user external_user_id: type: string required: - type - external_user_id additionalProperties: false description: >- Who owns the connection: the Workspace (a shared account), one user (their own account) or an end customer user in a reseller vault. ConnectionState: type: string enum: - PENDING_CONSENT - CONNECTED - REAUTH_REQUIRED - REVOKING - REVOKED - ERROR ApiErrorEntry: type: object properties: code: type: integer description: Machine-readable error code examples: - 7002 message: type: string description: Human-readable error message examples: - Resource not found path: type: array items: type: string description: Field path that caused the error, when applicable examples: - - body - name metadata: type: object additionalProperties: type: string required: - code - message additionalProperties: false securitySchemes: BearerAuth: description: >- workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.