GET /api/streams/{streamName}/attachments
Api key auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

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 authorization] Route required privileges: read_stream.

Path parameters

  • streamName string Required

    The name of the stream

Query parameters

  • query string

    Search query to filter attachments by title

  • attachmentTypes string | array[string]

    Filter by attachment types (single value or array)

    Values are dashboard, rule, or slo.

  • tags string | array[string]

    Filter by tags (single value or array)

application/json

Body

object object

Additional properties are NOT allowed.

Responses

  • 200 application/json

    Successfully retrieved attachments

GET /api/streams/{streamName}/attachments 
curl \
 --request GET 'https://<KIBANA_URL>/api/streams/{streamName}/attachments' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"value":{}}'
Request example 
{
  "value": {}
}
Response examples (200) 
{
  "attachments": [
    {
      "id": "dashboard-123",
      "tags": [
        "monitoring",
        "production"
      ],
      "type": "dashboard",
      "title": "My Dashboard",
      "createdAt": "2023-02-23T16:15:47.275Z",
      "updatedAt": "2023-03-24T14:39:17.636Z",
      "description": "Dashboard for monitoring production services",
      "streamNames": [
        "logs.awsfirehose",
        "logs.nginx"
      ]
    }
  ]
}