HOhoneycomb
Key Management

Update an API Key

Changed on

Updates an API Key. The expected attributes depend on the key type:

  • Ingest Keys (prefix hcxik_): Support name and enabled attributes
  • Configuration Keys (prefix hcxlk_): Support name, enabled, and permissions attributes
patch/2/teams/{teamSlug}/api-keys/{ID}

Request

  • Base URL
    https://api.honeycomb.io
  • URL
    https://api.honeycomb.io/2/teams/{teamSlug}/api-keys/{ID}
  • Auth
    HTTP bearer

Request body

Example request

{
  "data": {
    "id": "hcxik_12345678901234567890123456",
    "attributes": {
      "name": "updated key name",
      "description": "Used by the checkout service in prod. Rotate in AWS Secrets Manager."
    }
  }
}

Response

Success

Example response

{
  "data": {
    "id": "hcxik_12345678901234567890123456",
    "attributes": {
      "key_type": "ingest",
      "name": "us-west-2 collectors key",
      "description": "Used by the checkout service in prod. Rotate in AWS Secrets Manager.",
      "timestamps": {
        "created": "2022-09-22T17:32:11Z",
        "updated": "2022-10-31T15:08:11Z"
      }
    },
    "relationships": {
      "environment": {
        "data": {
          "id": "hxenv_12345678901234567890123456"
        }
      },
      "creator": {
        "data": {
          "id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0"
        }
      },
      "editor": {
        "data": {
          "id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0"
        }
      }
    },
    "links": {
      "self": "/2/teams/my-team/api-keys/hcxik_12345678901234567890123456"
    }
  }
}

Changes

  • 276c5555582aRevision changes
    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added ingest configuration discriminator mapping keys to the / response property for the response status