honeycomb · Schema

ApiKey

Properties

Name Type Description
id string Unique identifier for the API key.
name string The display name of the API key.
type string The type of API key.
disabled boolean Whether the API key is disabled.
permissions object The permissions granted to this API key.
environment_id string The environment this key is scoped to, if applicable.
secret string The API key secret, only returned upon creation.
created_at string ISO8601 formatted time the API key was created.
View JSON Schema on GitHub

JSON Schema

honeycomb-apikey-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiKey",
  "title": "ApiKey",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the API key."
    },
    "name": {
      "type": "string",
      "description": "The display name of the API key."
    },
    "type": {
      "type": "string",
      "description": "The type of API key.",
      "enum": [
        "configuration",
        "ingest"
      ]
    },
    "disabled": {
      "type": "boolean",
      "description": "Whether the API key is disabled."
    },
    "permissions": {
      "type": "object",
      "description": "The permissions granted to this API key.",
      "additionalProperties": {
        "type": "boolean"
      }
    },
    "environment_id": {
      "type": "string",
      "description": "The environment this key is scoped to, if applicable."
    },
    "secret": {
      "type": "string",
      "description": "The API key secret, only returned upon creation."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO8601 formatted time the API key was created."
    }
  }
}