Skip to main content

Create a snapshot

POST 
/v1/snapshotter

Creates a new Kibana snapshot and shares with recipients through email or notification endpoint. Please ensure to change the region in the URL to match your account's region.

Request​

Body

    snapshotType stringrequired

    Possible values: [DASHBOARD, VISUALIZATION]

    The object type to share

    snapshotSavedObjectId stringrequired

    ID of the object to share. If you don't know the object ID, you can use the /kibana/export endpoint.

    slackWebhookUrls string[]

    URLs of Slack webhooks that you want to send this snapshot to.
    At least one of emails, slackWebhookUrls, and endpoints is required with each request. If all three are missing, the request will fail.

    endpoints int32[]

    IDs of notification endpoints that you want to send this snapshot to
    At least one of emails, slackWebhookUrls, and endpoints is required with each request. If all three are missing, the request will fail.

    emails string[]

    Email addresses that you want to send this snapshot to
    At least one of emails, slackWebhookUrls, and endpoints is required with each request. If all three are missing, the request will fail.

    message string

    Message to send to the shared object recipients

    timeFrameFrom int64required

    Starting timedate of the visualization, as a Unix epoch integer.

    timeFrameTo int64required

    Ending timedate of the visualization, as a Unix epoch integer.

    snapshotTimeZone stringrequired

    Time zone to use in timeFrameFrom and timeFrameTo

    queryString string

    Search query

    darkTheme boolean

    To send the object with Kibana dark theme colors, true. Otherwise, false.

Responses​

successful operation

Schema
    snapshotId int32

    ID of the snapshot

Loading...