Get stream attachments

Base URL: https://{kibana_url}

GET /api/streams/{streamName}/attachments
GET /s/{space_id}/api/streams/{streamName}/attachments

Auth

Fetches all attachments linked to a stream that are visible to the current user in the current space. Optionally filter by attachment types, search query, and tags.

Required privileges

Privileges read_stream

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
streamName string · max length: 200 required: The name of the stream

Query parameters

query string · max length: 1000: Search query to filter attachments by title
attachmentTypes enum[] · max items: 3: Filter by attachment types (single value or array); Values: dashboard rule slo
tags string[] · max items: 100: Filter by tags (single value or array)

Request body

Any of:

Response

200

Successfully retrieved attachments

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/streams/STREAM_NAME/attachments
{}

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/streams/${STREAM_NAME}/attachments" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}'

Generated from the API spec

Response

{
  "attachments": [
    {
      "createdAt": "2023-02-23T16:15:47.275Z",
      "description": "Dashboard for monitoring production services",
      "id": "dashboard-123",
      "streamNames": [
        "logs.awsfirehose",
        "logs.nginx"
      ],
      "tags": [
        "monitoring",
        "production"
      ],
      "title": "My Dashboard",
      "type": "dashboard",
      "updatedAt": "2023-03-24T14:39:17.636Z"
    }
  ]
}