generated: '2026-10-13'
method: derived
generator: derive-vocabulary.py
source:
- openapi/cockroach-labs-api-keys-api-openapi.yml
- openapi/cockroach-labs-audit-logs-api-openapi.yml
- openapi/cockroach-labs-auth-api-openapi.yml
- openapi/cockroach-labs-backup-restore-api-openapi.yml
- openapi/cockroach-labs-billing-api-openapi.yml
vocabulary:
  name: Cockroach Labs Domain Vocabulary
  description: 'Terms declared by Cockroach Labs''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-13'
  terms:
  - term: Auth
    definition: Authenticate to the Cluster API by creating and terminating API sessions. Session tokens are passed via the X-Cockroach-API-Session
      header on subsequent requests.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-auth-api-openapi.yml
  - term: Billing
    definition: Retrieve invoices and billing information for the CockroachDB Cloud organization.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-billing-api-openapi.yml
  - term: Clusters
    definition: Create, list, retrieve, update, and delete CockroachDB Serverless and Dedicated clusters within an organization.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-clusters-api-openapi.yml
  - term: CMEK
    definition: Manage customer-managed encryption keys (CMEK) for encrypting cluster data at rest using customer-controlled keys.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-cmek-api-openapi.yml
  - term: Databases
    definition: Manage databases within a CockroachDB cluster, including creation, listing, updating, and deletion.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-databases-api-openapi.yml
  - term: EgressRules
    definition: Configure egress traffic rules and egress private endpoints for outbound cluster network traffic.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-egressrules-api-openapi.yml
  - term: Folders
    definition: Organize clusters and other resources into hierarchical folder structures within the organization.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-folders-api-openapi.yml
  - term: Health
    definition: Check the health and readiness of individual CockroachDB nodes. The health endpoint can report whether the node is live and fully
      operational for accepting SQL connections.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-health-api-openapi.yml
  - term: IPAllowlists
    definition: Configure IP allowlist entries to control network access to a cluster.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-ipallowlists-api-openapi.yml
  - term: JWTIssuers
    definition: Manage JWT issuer configurations for external identity provider integrations.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-jwtissuers-api-openapi.yml
  - term: LogExport
    definition: Configure log export to external destinations such as AWS CloudWatch or GCP Cloud Logging.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-logexport-api-openapi.yml
  - term: MetricExport
    definition: Configure metric export integrations including AWS CloudWatch, Datadog, and Prometheus.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-metricexport-api-openapi.yml
  - term: Nodes
    definition: Retrieve information about all nodes in the cluster, including their status, address, locality, and operational metrics.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-nodes-api-openapi.yml
  - term: Organizations
    definition: Retrieve information about the caller's CockroachDB Cloud organization.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-organizations-api-openapi.yml
  - term: Private Endpoints
    definition: Manage private endpoint services and connections for secure VPC-level access to clusters.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-private-endpoints-api-openapi.yml
  - term: Ranges
    definition: List and inspect range information for the cluster, including hot ranges by node and detailed information for specific range IDs.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-ranges-api-openapi.yml
  - term: Rules
    definition: Retrieve alerting rules templates for use with Prometheus-compatible alerting systems.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-rules-api-openapi.yml
  - term: Sessions
    definition: List active SQL sessions across all nodes of the cluster, with optional filtering by username.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-sessions-api-openapi.yml
  - term: SQLUsers
    definition: Manage SQL users for a cluster, including creating users, listing users, and updating SQL user passwords.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-sqlusers-api-openapi.yml
  - term: VersionDeferral
    definition: Manage cluster version deferral policies to delay automatic CockroachDB version upgrades.
    tags:
    - Resource Group
    source: openapi/cockroach-labs-versiondeferral-api-openapi.yml
  - term: Any
    definition: '`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
      In its binary encoding, an `Any` is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the
      type URL is described on the `type_url` field. Protobuf APIs provide utilities to interact with `Any` values: - A ''pack'' operation a'
    tags:
    - Object
    source: openapi/cockroach-labs-api-keys-api-openapi.yml#/components/schemas/Any
  - term: Status
    definition: 'Object declared by the contract with fields: code, details, message.'
    tags:
    - Object
    source: openapi/cockroach-labs-api-keys-api-openapi.yml#/components/schemas/Status
  - term: ListApiKeysResponse
    definition: 'Object declared by the contract with fields: api_keys, pagination.'
    tags:
    - Object
    source: openapi/cockroach-labs-api-keys-api-openapi.yml#/components/schemas/ListApiKeysResponse
  - term: KeysetPaginationResponse
    definition: 'Object declared by the contract with fields: next_page, previous_page.'
    tags:
    - Object
    source: openapi/cockroach-labs-api-keys-api-openapi.yml#/components/schemas/KeysetPaginationResponse
  - term: UpdateApiKeySpecification
    definition: 'Object declared by the contract with fields: name.'
    tags:
    - Object
    source: openapi/cockroach-labs-api-keys-api-openapi.yml#/components/schemas/UpdateApiKeySpecification
  - term: ApiKey
    definition: 'Object declared by the contract with fields: created_at, id, name, service_account_id.'
    tags:
    - Object
    source: openapi/cockroach-labs-api-keys-api-openapi.yml#/components/schemas/ApiKey
  - term: CreateApiKeyRequest
    definition: 'Object declared by the contract with fields: name, service_account_id.'
    tags:
    - Object
    source: openapi/cockroach-labs-api-keys-api-openapi.yml#/components/schemas/CreateApiKeyRequest
  - term: CreateApiKeyResponse
    definition: 'Object declared by the contract with fields: api_key, secret.'
    tags:
    - Object
    source: openapi/cockroach-labs-api-keys-api-openapi.yml#/components/schemas/CreateApiKeyResponse
  - term: Error
    definition: Standard error response returned by the API.
    tags:
    - Object
    source: openapi/cockroach-labs-api-keys-api-openapi.yml#/components/schemas/Error
  - term: PaginationResponse
    definition: Pagination metadata included in list responses.
    tags:
    - Object
    source: openapi/cockroach-labs-api-keys-api-openapi.yml#/components/schemas/PaginationResponse
  - term: AuditLogSource
    definition: 'Enumeration declared by the contract with values: AUDIT_LOG_SOURCE_CC_API, AUDIT_LOG_SOURCE_CLI, AUDIT_LOG_SOURCE_UI, AUDIT_LOG_SOURCE_INTERNAL,
      AUDIT_LOG_SOURCE_MCP, AUDIT_LOG_SOURCE_SSH_GATEWAY.'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-audit-logs-api-openapi.yml#/components/schemas/AuditLogSource
  - term: AuditLogMetadata
    definition: 'Object declared by the contract with fields: ip_address.'
    tags:
    - Object
    source: openapi/cockroach-labs-audit-logs-api-openapi.yml#/components/schemas/AuditLogMetadata
  - term: SystemActorName
    definition: SystemActorName identifies a system process that triggered an audit log entry when the action was not initiated by a human user
      or service account.
    tags:
    - Enumeration
    source: openapi/cockroach-labs-audit-logs-api-openapi.yml#/components/schemas/SystemActorName
  - term: ListAuditLogsResponse
    definition: 'Object declared by the contract with fields: entries, next_starting_from.'
    tags:
    - Object
    source: openapi/cockroach-labs-audit-logs-api-openapi.yml#/components/schemas/ListAuditLogsResponse
  - term: AuditLogEntry
    definition: AuditLogEntry represents an entry in the cloud event log. Note that this message definition should always match exactly with the
      corresponding `AuditLogEntry` message in `console/consolepb/console.proto`.
    tags:
    - Object
    source: openapi/cockroach-labs-audit-logs-api-openapi.yml#/components/schemas/AuditLogEntry
  - term: AuditLogAction
    definition: 'Enumeration declared by the contract with values: AUDIT_LOG_ACTION_CREATE_CLUSTER, AUDIT_LOG_ACTION_DELETE_CLUSTER, AUDIT_LOG_ACTION_INVITE_USER_TO_ORGANIZATION,
      AUDIT_LOG_ACTION_EDIT_USER_INVITE, AUDIT_LOG_ACTION_REVOKE_USER_INVITE, AUDIT_LOG_ACTION_ACCEPT_USER_INVITE, AUDIT_LOG_ACTION_ASSIGN_USER_ROLE,
      AUDIT_LOG_ACTION_DELETE_USER_FROM_ORGANIZATION, AUDIT_LOG_ACTION_CREATE_SERVICE_ACCOUNT, AUDIT_LOG_ACTION_UPDATE_SERVICE_ACCOUNT, AUDIT_LOG_ACTION_DELETE_SERVICE_ACCOUNT,
      AUDIT_LOG_ACTION_CREATE_API_KEY. (104 more)'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-audit-logs-api-openapi.yml#/components/schemas/AuditLogAction
  - term: LoginResponse
    definition: Response from a successful login request.
    tags:
    - Object
    source: openapi/cockroach-labs-auth-api-openapi.yml#/components/schemas/LoginResponse
  - term: LogoutResponse
    definition: Response from a logout request confirming session termination.
    tags:
    - Object
    source: openapi/cockroach-labs-auth-api-openapi.yml#/components/schemas/LogoutResponse
  - term: LoginRequest
    definition: Credentials for authenticating to the Cluster API.
    tags:
    - Object
    source: openapi/cockroach-labs-auth-api-openapi.yml#/components/schemas/LoginRequest
  - term: BackupSummary
    definition: 'Object declared by the contract with fields: as_of_time, id.'
    tags:
    - Object
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/BackupSummary
  - term: RestoreItem
    definition: 'Object declared by the contract with fields: database, schema, table.'
    tags:
    - Object
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/RestoreItem
  - term: UpdateBackupConfigurationSpec
    definition: 'Object declared by the contract with fields: enabled, frequency_minutes, retention_days.'
    tags:
    - Object
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/UpdateBackupConfigurationSpec
  - term: CreateRestoreBody
    definition: 'Object declared by the contract with fields: backup_id, objects, restore_opts, source_cluster_id, type.'
    tags:
    - Object
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/CreateRestoreBody
  - term: RestoreType.Type
    definition: 'Enumeration declared by the contract with values: CLUSTER, DATABASE, TABLE.'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/RestoreType.Type
  - term: ListRestoresResponse
    definition: 'Object declared by the contract with fields: pagination, restores.'
    tags:
    - Object
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/ListRestoresResponse
  - term: RestoreOpts
    definition: 'Object declared by the contract with fields: into_db, new_db_name, schema_only, skip_localities_check, skip_missing_foreign_keys,
      skip_missing_sequences, skip_missing_views.'
    tags:
    - Object
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/RestoreOpts
  - term: ListBackupsResponse
    definition: 'Object declared by the contract with fields: backups, pagination.'
    tags:
    - Object
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/ListBackupsResponse
  - term: BackupConfiguration
    definition: 'Object declared by the contract with fields: enabled, frequency_minutes, retention_days.'
    tags:
    - Object
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/BackupConfiguration
  - term: Restore
    definition: 'Object declared by the contract with fields: backup_end_time, backup_id, client_error_code, client_error_message, completed_at,
      completion_percent, crdb_job_id, created_at, destination_cluster_name, id, objects, restore_opts. (3 more)'
    tags:
    - Object
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/Restore
  - term: RestoreStatus.Type
    definition: 'Enumeration declared by the contract with values: PENDING, SUCCESS, FAILED.'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/RestoreStatus.Type
  - term: CreateRestoreRequest
    definition: Request body for initiating a cluster restore.
    tags:
    - Object
    source: openapi/cockroach-labs-backup-restore-api-openapi.yml#/components/schemas/CreateRestoreRequest
  - term: Invoice
    definition: A billing invoice for a CockroachDB Cloud organization.
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/Invoice
  - term: ListInvoicesResponse
    definition: List of invoices for the organization.
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/ListInvoicesResponse
  - term: DedicatedHardwareConfig
    definition: 'Object declared by the contract with fields: disk_iops, machine_type, memory_gib, num_virtual_cpus, storage_gib.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/DedicatedHardwareConfig
  - term: NetworkVisibility.Type
    definition: 'Enumeration declared by the contract with values: PUBLIC, PRIVATE.'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/NetworkVisibility.Type
  - term: Currency.Type
    definition: '- COCKROACH_CREDITS: COCKROACH_CREDITS is the same credits currency as CRDB_CLOUD_CREDITS, reported under its current name. Organizations
      on Continuum receive this value; all others continue to receive CRDB_CLOUD_CREDITS.'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/Currency.Type
  - term: CloudProvider.Type
    definition: '- GCP: The Google Cloud Platform cloud provider. - AWS: The Amazon Web Services cloud provider. - AZURE: The Azure cloud provider.'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/CloudProvider.Type
  - term: Cluster
    definition: 'Object declared by the contract with fields: account_id, azure_cluster_identity_client_id, cidr_range, cloud_provider, cockroach_version,
      config, created_at, creator_id, customer_cloud_account, delete_protection, deleted_at, edition. (13 more)'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/Cluster
  - term: EgressTrafficPolicy.Type
    definition: '- UNSPECIFIED: UNSPECIFIED signifies the egress traffic policy is unspecified. - ERROR: ERROR signifies there has been an internal
      server error during an update to the egress traffic policy. - ALLOW_ALL: ALLOW_ALL signifies all outbound connections from CockroachDB are
      allowed. - DEFAULT_DENY: DEFAULT_DENY signifies that CockroachDB can only initiate network connections to destinations explicitly '
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/EgressTrafficPolicy.Type
  - term: QuantityUnit.Type
    definition: 'Enumeration declared by the contract with values: HOURS, REQUEST_UNITS, GIB, GIB_HOURS, VCPU_HOURS.'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/QuantityUnit.Type
  - term: HostClusterConfig
    definition: HostClusterConfig describes the hardware of a host cluster.
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/HostClusterConfig
  - term: ListInvoicesResponse_2
    definition: 'Object declared by the contract with fields: invoices.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/ListInvoicesResponse_2
  - term: FolderResourceType.Type
    definition: 'Enumeration declared by the contract with values: FOLDER, CLUSTER.'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/FolderResourceType.Type
  - term: AwsCustomerCloudAccount
    definition: 'Object declared by the contract with fields: arn.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/AwsCustomerCloudAccount
  - term: ClusterUpgradeStatus.Type
    definition: '- FINALIZED: The cluster is running the latest available CockroachDB version, and all upgrades have been finalized. - MAJOR_UPGRADE_RUNNING:
      An major version upgrade is currently in progress. - UPGRADE_AVAILABLE: An upgrade is available. If preview builds are enabled for the parent
      organization, this could indicate that a preview upgrade is available. - PENDING_FINALIZATION: An upgrade is complete'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/ClusterUpgradeStatus.Type
  - term: CurrencyAmount
    definition: 'Object declared by the contract with fields: amount, currency.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/CurrencyAmount
  - term: InvoiceAdjustment
    definition: 'Object declared by the contract with fields: amount, name.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/InvoiceAdjustment
  - term: PathSegment
    definition: 'Object declared by the contract with fields: id, name.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/PathSegment
  - term: ClusterState.Type
    definition: '- LOCKED: An exclusive operation is being performed on this cluster. Other operations should not proceed if they did not set
      a cluster into the LOCKED state.'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/ClusterState.Type
  - term: Plan.Type
    definition: '- BASIC: The Basic plan includes essential operational features, is available in select regions, and offers on-demand capacity,
      making it ideal for small teams with unpredictable workloads. - STANDARD: The Standard plan includes standard enterprise security and monitoring
      features, is available in all supported regions, and offers provisioned pricing, making it the default choice for most Cockroac'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/Plan.Type
  - term: InvoiceItem
    definition: 'Object declared by the contract with fields: cluster, line_items, totals.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/InvoiceItem
  - term: LineItem
    definition: 'Object declared by the contract with fields: description, quantity, quantity_unit, total, unit_cost.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/LineItem
  - term: AzureCustomerCloudAccount
    definition: 'Object declared by the contract with fields: subscription_id, tenant_id.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/AzureCustomerCloudAccount
  - term: Region
    definition: 'Object declared by the contract with fields: disk_iops, internal_dns, machine_type, name, node_count, num_virtual_cpus, primary,
      private_endpoint_dns, s3_vpc_endpoint_id, sql_dns, ui_dns.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/Region
  - term: VirtualClusterConfig
    definition: 'VirtualClusterConfig describes a virtual cluster: a tenant running on a customer-owned host cluster, as a member of a workspace.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/VirtualClusterConfig
  - term: CustomerCloudAccount
    definition: 'Object declared by the contract with fields: aws, azure, gcp.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/CustomerCloudAccount
  - term: GcpCustomerCloudAccount
    definition: 'Object declared by the contract with fields: service_account_email.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/GcpCustomerCloudAccount
  - term: Edition.Type
    definition: 'A Continuum edition, which determines the capabilities a cluster''s license grants. Editions are available only to clusters in
      Cockroach Continuum organizations, and a request that sets an edition from a non-Continuum organization is rejected. Editions and plans
      are mutually exclusive, so a cluster reports one or the other, never both. - STANDARD: The Standard edition grants the Standard capability'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/Edition.Type
  - term: ServerlessClusterConfig
    definition: 'Object declared by the contract with fields: routing_id, upgrade_type, usage_limits.'
    tags:
    - Object
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/ServerlessClusterConfig
  - term: UpgradeType.Type
    definition: 'Enumeration declared by the contract with values: MANUAL, AUTOMATIC.'
    tags:
    - Enumeration
    source: openapi/cockroach-labs-billing-api-openapi.yml#/components/schemas/UpgradeType.Type