CreateGrafanaDashboard - Chronosphere Documentation

Authorizations

API-Token

string

header

required

Chronosphere API token

Body

application/json

dry_run

boolean

If true, validates the specified configuration without creating the GrafanaDashboard. If the specified configuration is valid, the endpoint returns a partial response without the GrafanaDashboard. If the specified configuration is invalid, the endpoint returns an error.

grafana_dashboard

object

The GrafanaDashboard to create.

Show child attributes

grafana_dashboard.name

string

required

The name of the GrafanaDashboard. You can modify this value after the GrafanaDashboard is created.

grafana_dashboard.bucket_slug

string

Slug of the bucket the dashboard belongs to. Required if collection_slug is not set.

grafana_dashboard.collection

object

Collection that the monitor belongs to. Required if bucket_slug and collection_slug are not set.

Show child attributes

grafana_dashboard.collection.slug

string

grafana_dashboard.collection.type

enum<string>

Type values must match entitiespb.Collection.CollectionType.

Available options:

SIMPLE,

SERVICE

grafana_dashboard.collection_slug

string

Slug of the collection the dashboard belongs to. Required if bucket_slug is not set.

grafana_dashboard.dashboard_json

string

Required raw JSON of the Grafana dashboard.

grafana_dashboard.slug

string

The unique identifier of the GrafanaDashboard. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the GrafanaDashboard is created.

Response

A successful response containing the created GrafanaDashboard.

grafana_dashboard

object

Show child attributes

grafana_dashboard.name

string

required

The name of the GrafanaDashboard. You can modify this value after the GrafanaDashboard is created.

grafana_dashboard.bucket_slug

string

Slug of the bucket the dashboard belongs to. Required if collection_slug is not set.

grafana_dashboard.collection

object

Collection that the monitor belongs to. Required if bucket_slug and collection_slug are not set.

Show child attributes

grafana_dashboard.collection.slug

string

grafana_dashboard.collection.type

enum<string>

Type values must match entitiespb.Collection.CollectionType.

Available options:

SIMPLE,

SERVICE

grafana_dashboard.collection_slug

string

Slug of the collection the dashboard belongs to. Required if bucket_slug is not set.

grafana_dashboard.created_at

string<date-time>

Timestamp of when the GrafanaDashboard was created. Cannot be set by clients.

grafana_dashboard.dashboard_json

string

Required raw JSON of the Grafana dashboard.

grafana_dashboard.slug

string

The unique identifier of the GrafanaDashboard. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the GrafanaDashboard is created.

grafana_dashboard.updated_at

string<date-time>

Timestamp of when the GrafanaDashboard was last updated. Cannot be set by clients.

Endpoints

Authorizations

Body

Response