CockroachDB Cloud API — APIKeys

naftiko: 1.0.0-alpha2
info:
  label: CockroachDB Cloud API — APIKeys
  description: 'CockroachDB Cloud API — APIKeys. 5 operations. Lead operation: List API keys. Self-contained Naftiko capability
    covering one Cockroachdb business surface.'
  tags:
  - Cockroachdb
  - APIKeys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COCKROACHDB_API_KEY: COCKROACHDB_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-apikeys
    baseUri: https://cockroachlabs.cloud
    description: CockroachDB Cloud API — APIKeys business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-api-keys
      path: /api/v1/api-keys
      operations:
      - name: listapikeys
        method: GET
        description: List API keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: service_account_id
          in: query
          type: string
          description: Filter API keys by the associated service account ID.
      - name: createapikey
        method: POST
        description: Create an API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-api-keys-id
      path: /api/v1/api-keys/{id}
      operations:
      - name: getapikey
        method: GET
        description: Get an API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateapikey
        method: PATCH
        description: Update an API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteapikey
        method: DELETE
        description: Delete an API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.COCKROACHDB_API_KEY}}'
  exposes:
  - type: rest
    namespace: cloud-apikeys-rest
    port: 8080
    description: REST adapter for CockroachDB Cloud API — APIKeys. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/api-keys
      name: api-v1-api-keys
      description: REST surface for api-v1-api-keys.
      operations:
      - method: GET
        name: listapikeys
        description: List API keys
        call: cloud-apikeys.listapikeys
        with:
          service_account_id: rest.service_account_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createapikey
        description: Create an API key
        call: cloud-apikeys.createapikey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/api-keys/{id}
      name: api-v1-api-keys-id
      description: REST surface for api-v1-api-keys-id.
      operations:
      - method: GET
        name: getapikey
        description: Get an API key
        call: cloud-apikeys.getapikey
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateapikey
        description: Update an API key
        call: cloud-apikeys.updateapikey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteapikey
        description: Delete an API key
        call: cloud-apikeys.deleteapikey
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-apikeys-mcp
    port: 9090
    transport: http
    description: MCP adapter for CockroachDB Cloud API — APIKeys. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-api-keys
      description: List API keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-apikeys.listapikeys
      with:
        service_account_id: tools.service_account_id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-api-key
      description: Create an API key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-apikeys.createapikey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-api-key
      description: Get an API key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-apikeys.getapikey
      outputParameters:
      - type: object
        mapping: $.
    - name: update-api-key
      description: Update an API key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-apikeys.updateapikey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-api-key
      description: Delete an API key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cloud-apikeys.deleteapikey
      outputParameters:
      - type: object
        mapping: $.