CockroachDB Cloud API — IPAllowlists

naftiko: 1.0.0-alpha2
info:
  label: CockroachDB Cloud API — IPAllowlists
  description: 'CockroachDB Cloud API — IPAllowlists. 4 operations. Lead operation: List IP allowlist entries. Self-contained
    Naftiko capability covering one Cockroachdb business surface.'
  tags:
  - Cockroachdb
  - IPAllowlists
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COCKROACHDB_API_KEY: COCKROACHDB_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-ipallowlists
    baseUri: https://cockroachlabs.cloud
    description: CockroachDB Cloud API — IPAllowlists business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-clusters-cluster_id-networking-allowlist
      path: /api/v1/clusters/{cluster_id}/networking/allowlist
      operations:
      - name: listallowlistentries
        method: GET
        description: List IP allowlist entries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addallowlistentry
        method: POST
        description: Add IP allowlist entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-clusters-cluster_id-networking-allowlist-cidr_ip-cidr_mask
      path: /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}
      operations:
      - name: updateallowlistentry
        method: PATCH
        description: Update IP allowlist entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteallowlistentry
        method: DELETE
        description: Delete IP allowlist entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.COCKROACHDB_API_KEY}}'
  exposes:
  - type: rest
    namespace: cloud-ipallowlists-rest
    port: 8080
    description: REST adapter for CockroachDB Cloud API — IPAllowlists. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/clusters/{cluster-id}/networking/allowlist
      name: api-v1-clusters-cluster-id-networking-allowlist
      description: REST surface for api-v1-clusters-cluster_id-networking-allowlist.
      operations:
      - method: GET
        name: listallowlistentries
        description: List IP allowlist entries
        call: cloud-ipallowlists.listallowlistentries
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addallowlistentry
        description: Add IP allowlist entry
        call: cloud-ipallowlists.addallowlistentry
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/clusters/{cluster-id}/networking/allowlist/{cidr-ip}/{cidr-mask}
      name: api-v1-clusters-cluster-id-networking-allowlist-cidr-ip-cidr-mask
      description: REST surface for api-v1-clusters-cluster_id-networking-allowlist-cidr_ip-cidr_mask.
      operations:
      - method: PATCH
        name: updateallowlistentry
        description: Update IP allowlist entry
        call: cloud-ipallowlists.updateallowlistentry
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteallowlistentry
        description: Delete IP allowlist entry
        call: cloud-ipallowlists.deleteallowlistentry
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-ipallowlists-mcp
    port: 9090
    transport: http
    description: MCP adapter for CockroachDB Cloud API — IPAllowlists. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-ip-allowlist-entries
      description: List IP allowlist entries
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-ipallowlists.listallowlistentries
      outputParameters:
      - type: object
        mapping: $.
    - name: add-ip-allowlist-entry
      description: Add IP allowlist entry
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: cloud-ipallowlists.addallowlistentry
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-ip-allowlist-entry
      description: Update IP allowlist entry
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-ipallowlists.updateallowlistentry
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-ip-allowlist-entry
      description: Delete IP allowlist entry
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cloud-ipallowlists.deleteallowlistentry
      outputParameters:
      - type: object
        mapping: $.