Couchbase · Schema

ApiKeyCreateRequest

Request to create an API key

AnalyticsApp ServicesBackupCapellaCloudDatabaseDatabase-as-a-ServiceEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name Type Description
name string Name for the API key
description string Description of the API key
expiry number Expiry time in days (0 for no expiry)
organizationRoles array Organization-level roles
resources array Project-specific role assignments
allowedCIDRs array CIDRs allowed to use this API key
View JSON Schema on GitHub

JSON Schema

couchbase-apikeycreaterequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiKeyCreateRequest",
  "title": "ApiKeyCreateRequest",
  "type": "object",
  "description": "Request to create an API key",
  "required": [
    "name",
    "organizationRoles"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name for the API key"
    },
    "description": {
      "type": "string",
      "description": "Description of the API key"
    },
    "expiry": {
      "type": "number",
      "description": "Expiry time in days (0 for no expiry)"
    },
    "organizationRoles": {
      "type": "array",
      "description": "Organization-level roles",
      "items": {
        "type": "string",
        "enum": [
          "organizationOwner",
          "organizationMember",
          "projectCreator"
        ]
      }
    },
    "resources": {
      "type": "array",
      "description": "Project-specific role assignments",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Project UUID"
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "projectOwner",
                "projectManager",
                "projectViewer",
                "projectDataReaderWriter",
                "projectDataReader"
              ]
            }
          }
        }
      }
    },
    "allowedCIDRs": {
      "type": "array",
      "description": "CIDRs allowed to use this API key",
      "items": {
        "type": "string"
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/couchbase-apikeycreaterequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.