Documentation by ClonePartner

Start typing to search.

API Reference

Create a dashboard on a job

View Markdown
POST /api/jobs/{jobId}/dashboards

Create a dashboard on a job

Operation IDcreateJobDashboard

Authentication

  • BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

jobIdintegerrequired

Request body

This request body is required.

Content typeapplication/json

requestobject
4 properties
namestringrequired
descriptionstring
yaml_contentstringrequired
dashboard_template_idinteger

Success response body

201Dashboard created

Dashboard created

Content typeapplication/json

responseobject
9 properties
idinteger
job_idinteger
dashboard_template_idinteger | null
Nullable
yes
namestring
descriptionstring | null
Nullable
yes
statusstring
has_share_linkboolean
created_atstring · date-time
updated_atstring | null · date-time
Nullable
yes

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404Resource not found

Resource not found

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}