Skip to content

Ephemeral Dashboard#

It's a dashboard but with a TTL. That means after a defined duration, the dashboard will be removed from the database.

We are providing this resource mainly to create a dashboard preview from a pull request.

kind: "EphemeralDashboard"
metadata:
  name: <string>
  project: <string>
spec: <ephemeral_dashboard_specification>

See the next section to get details about the <ephemeral_dashboard_specification>.

Ephemeral Dashboard specification#

It's a merge with the dashboard_spec and an additional field ttl.

ttl: <duration>
  <dashboard_spec>

API definition#

Get a list of EphemeralDashboard#

GET /api/v1/projects/<project_name>/ephemeraldashboards

URL query parameters:

  • name = <string> : filters the list of ephemeral dashboards based on their name (prefix match).

Get a single EphemeralDashboard#

GET /api/v1/projects/<project_name>/ephemeraldashboards/<ephemeraldashboard_name>

Create a single EphemeralDashboard#

POST /api/v1/projects/<project_name>/ephemeraldashboards

Update a single EphemeralDashboard#

PUT /api/v1/projects/<project_name>/ephemeraldashboards/<ephemeraldashboard_name>

Delete a single EphemeralDashboard#

DELETE /api/v1/projects/<project_name>/ephemeraldashboards/<ephemeraldashboard_name>