COcouchbase
Api Keys

Get API Key

Changed on

Fetches the details of the given API key under an organization.

Organization Owners can get any API key inside the Organization.

Organization Members and Project Creator can get any Project scoped API key for which they are Project Owner.

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/apikeys/{ApiKeyId}

Request

Response

Successfully fetched the API key by its Access key.

idstring required

The id is a unique identifier for an apiKey.

namestring required

Name of the API key.

descriptionstring required

Description for the API key.

expirynumber float required

Expiry of the API key in number of days. Must be at least 0.01 days. If set to -1, the token will not expire.

allowedCIDRsstring[] required

List of inbound CIDRs for the API key. The system making a request must come from one of the allowed CIDRs.

organizationRolesAPIKeyOrganizationRoles[] required

Example response

{
  "id": "IS9DrRsw4KWFS72Zhbj4xmhllHvPcdCL",
  "name": "Production",
  "description": "API key to manage production Capella Cluster.",
  "allowedCIDRs": [
    "0.0.0.0/0"
  ],
  "organizationRoles": [
    "organizationMember"
  ],
  "resources": [
    {
      "id": "ffffffff-aaaa-1414-eeee-000000000000",
      "roles": [
        "projectDataReaderWriter",
        "projectManager"
      ]
    }
  ],
  "audit": {
    "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "createdAt": "2021-09-01T12:34:56Z",
    "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "modifiedAt": "2021-09-01T12:34:56Z",
    "version": 1
  }
}

Changes

  • a5e88bcf71cbRevision changes
    • warning

      added the new organizationBillingAdmin enum value to the / response property for the response status

    • warning

      added the new organizationBillingViewer enum value to the / response property for the response status

    • warning

      added the new organizationReadOnly enum value to the / response property for the response status