{
  "opencollection": "1.0.0",
  "info": {
    "name": "Honeycomb Auth Key Management API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Key Management",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all API Keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.honeycomb.io/2/teams/:teamSlug/api-keys",
            "params": [
              {
                "name": "teamSlug",
                "value": "",
                "type": "path",
                "description": "The slug of the Team"
              },
              {
                "name": "page[after]",
                "value": "eyxJjcmAVhdGVkX",
                "type": "query",
                "description": "The string value of the `next` attribute from a previous result page.\nThe cursor value must be empty or omitted for the first request of a cursor-paginated query.\n"
              },
              {
                "name": "page[size]",
                "value": "10",
                "type": "query",
                "description": "The number of entries to include per response. Maximum value is 100."
              },
              {
                "name": "filter[type]",
                "value": "",
                "type": "query",
                "description": "Specifies the type of API key to return. This parameter accepts the following values:\n  - `ingest`: Returns only ingest API keys.\n  - `configuration`:  Returns only configuration API keys.\n\nThe endpoint will default to fetching all API keys regardless of type if this filter is omitted.\n"
              }
            ]
          },
          "docs": "List all API Keys for a Team.\n"
        },
        {
          "info": {
            "name": "Create an API Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.honeycomb.io/2/teams/:teamSlug/api-keys",
            "params": [
              {
                "name": "teamSlug",
                "value": "",
                "type": "path",
                "description": "The slug of the Team"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This creates an API Key, which will return the API Key components in the response. The Key ID will be found at `data.id` and\nthe Key Secret will be found at `data.attributes.secret`. For security reasons the Key Secret will only be available during creation so make sure to save it.\n\nTo use a newly-created Ingest Key it should be passed in the `X-Honeycomb-Team` header with the API Key's ID and secret\nconcatenated (and with no separator). For example, `X-Honeycomb-Team: hcxik_12345678901234567890"
        },
        {
          "info": {
            "name": "Get an API Key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.honeycomb.io/2/teams/:teamSlug/api-keys/:ID",
            "params": [
              {
                "name": "teamSlug",
                "value": "",
                "type": "path",
                "description": "The slug of the Team"
              },
              {
                "name": "ID",
                "value": "",
                "type": "path",
                "description": "A unique identifier"
              }
            ]
          },
          "docs": "Fetches an environment API Key, either a key of type `ingest` or type `configuration` based on the\nID given.\n"
        },
        {
          "info": {
            "name": "Update an API Key",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.honeycomb.io/2/teams/:teamSlug/api-keys/:ID",
            "params": [
              {
                "name": "teamSlug",
                "value": "",
                "type": "path",
                "description": "The slug of the Team"
              },
              {
                "name": "ID",
                "value": "",
                "type": "path",
                "description": "A unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an API Key. The expected attributes depend on the key type:\n- **Ingest Keys** (prefix `hcxik_`): Support `name` and `enabled` attributes\n- **Configuration Keys** (prefix `hcxlk_`): Support `name`, `enabled`, and `permissions` attributes\n"
        },
        {
          "info": {
            "name": "Delete an API Key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.honeycomb.io/2/teams/:teamSlug/api-keys/:ID",
            "params": [
              {
                "name": "teamSlug",
                "value": "",
                "type": "path",
                "description": "The slug of the Team"
              },
              {
                "name": "ID",
                "value": "",
                "type": "path",
                "description": "A unique identifier"
              }
            ]
          },
          "docs": "This deletes and immediately deactivates the API Key. This is an irreversible operation.\n"
        }
      ]
    }
  ],
  "bundled": true
}