Get a tag Experimental; added in 9.5.0

GET /api/tags/{id}

Spaces method and path for this operation:

get /s/{space_id}/api/tags/{id}

Refer to Spaces for more information.

Returns a tag by ID.

Path parameters

  • id string Required

    The tag ID, as returned by the create or search endpoints.

Responses

  • 200 application/json

    success

    Hide response attributes Show response attributes object
    • data object Required

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • color string Required

        The tag color as a hex value (e.g. #772299). If omitted, a random color is generated.

      • description string

        Optional description of the tag.

      • name string Required

        The display name of the tag.

    • id string Required

      The tag ID.

    • meta object Required

      Additional properties are NOT allowed.

      Hide meta attributes Show meta attributes object
      • created_at string

        Timestamp when the object was created (ISO 8601).

      • created_by string

        User profile ID of the user who created the object.

      • managed boolean

        When true, the object is managed by Kibana and cannot be edited by users.

      • owner string

        Identifier of the plugin or team that owns this object.

      • updated_at string

        Timestamp when the object was last updated (ISO 8601).

      • updated_by string

        User profile ID of the user who last updated the object.

      • version string

        Internal version identifier for optimistic concurrency control.

  • 403

    forbidden

  • 404

    not found

GET /api/tags/{id}
curl \
 --request GET 'https://localhost:5601/api/tags/{id}' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "data": {
    "color": "#1BA9F5",
    "description": "Dashboards owned by engineering teams.",
    "name": "Engineering"
  },
  "id": "tag-engineering",
  "meta": {
    "created_at": "2026-06-01T12:00:00.000Z",
    "managed": false,
    "updated_at": "2026-06-01T12:00:00.000Z",
    "version": "WzEsMV0="
  }
}