> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Enable or disable API token
>
This endpoint requires **Organization Admin** permissions.
Disable or re-enable an API token. To permanently revoke a token, use the [Delete API token](/api/api-tokens/delete-api-token) endpoint.
This operation is **idempotent**: calling it twice with the same body produces the same result.
## OpenAPI
````yaml /api/openapi.yaml put /v1/api-keys/{id}
openapi: 3.1.0
info:
title: Omni API
description: >
The Omni REST API provides programmatic access to your Omni instance for
managing users, documents, queries, schedules, and more.
version: 1.0.0
contact:
name: Omni Support
url: https://docs.omni.co
servers:
- url: https://{instance}.omniapp.co/api
description: Production
variables:
instance:
default: blobsrus
description: Your production Omni instance subdomain
- url: https://{instance}.playground.exploreomni.dev/api
description: Playground
variables:
instance:
default: blobsrus
description: Your playground Omni instance subdomain
security:
- bearerAuth: []
- orgApiKey: []
tags:
- name: AI
description: AI-powered query generation
- name: API Tokens
description: >-
Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
grants)
- name: Connections
description: Manage database connections
- name: Connection environments
description: Manage connection environments database connections
- name: Content
description: Unified content retrieval (documents and folders)
- name: Content migration
description: Export and import dashboards
- name: Content validator
description: Validate content against models and perform find/replace operations
- name: Dashboard downloads
description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
- name: Dashboard filters and controls
description: Read and update dashboard filter and control default values
- name: dbt
description: Manage dbt configuration for connections
- name: Documents
description: Create, retrieve, and manage documents
- name: Document favorites
description: Favorite and unfavorite documents
- name: Document labels
description: Apply and manage labels on documents
- name: Document permissions
description: Manage document-level access
- name: Labels
description: >
Manage labels in an organization. Labels can be applied to documents and
folders to help organize and categorize content.
**Label types:**
- **Basic labels**: Can be created and managed by any user
- **Verified labels**: Indicate curated or officially sanctioned content.
Admin-only.
- **Homepage labels**: Appear on the organization homepage. Admin-only.
- name: Folders
description: Create and organize content folders
- name: Folder permissions
description: Manage folder-level access
- name: Jobs
description: Check status of asynchronous jobs
- name: Models
description: Create and manage data models
- name: Model branches
description: Manage model branches and merge changes
- name: Model git configuration
description: Manage git configuration for shared models
- name: Queries
description: Execute workbook queries
- name: Schedules
description: Create and manage scheduled tasks
- name: Schedule recipients
description: Manage schedule recipients
- name: Schema refresh schedules
description: Manage automated schema refresh schedules for connections
- name: Topics
description: Retrieve topic information from models
- name: Uploads
description: Manage file uploads
- name: Users
description: Manage users
- name: User attributes
description: Manage user attribute definitions
- name: User groups
description: Manage user groups
- name: User model roles
description: Manage model and connection role assignments for users
- name: User group model roles
description: Manage model and connection role assignments for user groups
- name: Uploads
description: Manage CSV and spreadsheet uploads
paths:
/v1/api-keys/{id}:
put:
tags:
- API Tokens
summary: Enable or disable API token
description: >
This endpoint requires **Organization Admin** permissions.
Disable or re-enable an API token. To permanently revoke a token, use
the [Delete API token](/api/api-tokens/delete-api-token) endpoint.
This operation is **idempotent**: calling it twice with the same body
produces the same result.
operationId: updateApiKey
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: >-
UUID of the API token. The token must exist in the authenticating
user's organization.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- enabled
properties:
enabled:
type: boolean
description: >
Determines if the API token is enabled: `false` to disable
the token, `true` to re-enable it.
additionalProperties: false
examples:
disable:
summary: Disable a token
value:
enabled: false
enable:
summary: Enable a token
value:
enabled: true
responses:
'200':
description: >-
Token updated successfully. Returns the current state of the token,
or the same state if already in the requested state.
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
description: Unique ID for the token.
name:
type: string
description: Token name.
type:
type: string
enum:
- organization
- personal
- mcp
description: Token type.
enabled:
type: boolean
description: Whether the token is enabled.
createdAt:
type: string
format: date-time
description: ISO 8601 timestamp of when the token was created.
membershipId:
type: string
format: uuid
nullable: true
description: >-
Membership ID of the user who owns the token. `null` for
Organization API keys.
example:
id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
name: CI deployment key
type: organization
enabled: false
createdAt: '2026-04-20T10:00:00.000Z'
membershipId: null
'400':
description: >
Bad Request. Validation errors include:
- `id: Invalid UUID` - The token ID is not a valid UUID format
- `enabled: Invalid input: expected boolean, received string` -
Non-boolean value provided for `enabled`
- `Unrecognized key: ""` - Unknown field in request body
content:
application/json:
schema:
type: object
properties:
detail:
type: string
status:
type: integer
examples:
invalidUuid:
summary: Malformed UUID
value:
detail: 'Bad Request: id: Invalid UUID'
status: 400
nonBooleanValue:
summary: Non-boolean enabled value
value:
detail: >-
Bad Request: enabled: Invalid input: expected boolean,
received string
status: 400
unknownField:
summary: Unknown field in request body
value:
detail: 'Bad Request: Unrecognized key: "name"'
status: 400
'403':
description: >
Forbidden. Requires Organization Admin permissions, or
authentication failed.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: integer
message:
type: string
example:
error:
code: 403
message: Invalid bearer token
'404':
description: >
Not Found. The token does not exist or belongs to a different
organization.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
status:
type: integer
example:
detail: >-
Api key with id 00000000-0000-0000-0000-000000000000 does not
exist
status: 404
'405':
$ref: '#/components/responses/MethodNotAllowed'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- bearerAuth: []
components:
responses:
MethodNotAllowed:
description: Method Not Allowed - Invalid HTTP method for this endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
TooManyRequests:
description: Too Many Requests - Rate limit exceeded (60 requests/minute)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Can be either an [Organization API
Key](/api/authentication#organization-api-keys) or [Personal Access
Token (PAT)](/api/authentication#personal-access-tokens-pat).
Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
orgApiKey:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Requires an [Organization API
Key](/api/authentication#organization-api-keys). Personal Access Tokens
(PATs) are not supported for this endpoint.
Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`
````