Sign in
API Keys (iam/v2)

List of API Keys

General Availability

Retrieve a sorted, filtered, paginated list of all API keys.

This can show all keys for a single owner (across resources - Kafka clusters), or all keys for a single resource (across owners). If no owner or resource filters are specified, returns all API Keys in the organization. You will only see the keys that are accessible to the account making the API request.

get/iam/v2/api-keys

Query parameters

spec.ownerstring

Filter a collection by a string search

Filter the results by exact match for spec.owner.

spec.resourcestring

Filter a collection by a string search

Filter the results by exact match for spec.resource.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

API Key.

api_version'iam/v2' required

APIVersion defines the schema version of this representation of a resource.

kind'ApiKeyList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/iam/v2/api-keys",
    "last": "https://api.confluent.cloud/iam/v2/api-keys?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/iam/v2/api-keys?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/iam/v2/api-keys?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/iam/v2/api-keys/ak-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/api-key=ak-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "spec": {
        "secret": "R15hoiDIq8Nxu/lY4mPO3DwAVIfU5W7OI+efsB607mLgHTnVW5XJGVqX2ysDx987",
        "display_name": "CI kafka access key",
        "description": "This API key provides kafka access to cluster x",
        "owner": {
          "id": "u-a83k9b",
          "related": "https://api.confluent.cloud/iam/v2/users/u-a83k9b",
          "resource_name": "https://api.confluent.cloud/user=u-a83k9b"
        },
        "resource": {
          "id": "lkc-c29js0",
          "related": "https://api.confluent.cloud/cmk/v2/clusters/lkc-c29js0",
          "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-c29js0"
        }
      }
    }
  ]
}

Changes

Changed in 1 of the 4 revisions of this API.1

  • 1833d767d77c1See the full diff
    • ●

      removed the optional property /////////// from the response with the status

      response-optional-property-removed