Update a dashboard

PATCH /api/dashboards/{id}

Update a dashboard

Operation ID: updateDashboard

Authentication

Option 1

• BearerAuth (http bearer) API key token. Create via POST /api/api-keys. Format: envoy_<hex>

Option 2

• CookieAuth (apiKey) Session cookie set after login + TOTP verification

Path parameters

• id — integer, required Resource ID

Request body

application/json

• Type: object
• Properties:
  • name (string)
  • description (string)
  • yaml_content (string)
  • status (string)

Success responses

200

Updated dashboard

Content type: application/json

• Reference: Dashboard
  • Type: object
  • Properties:
    • id (integer)
    • job_id (integer)
    • dashboard_template_id (integer | null)
      • Nullable: yes
    • name (string)
    • description (string | null)
      • Nullable: yes
    • status (string)
    • has_share_link (boolean)
    • created_at (string)
      • Format: date-time
    • updated_at (string | null)
      • Format: date-time
      • Nullable: yes

Error responses

400

Validation error

Content type: application/json

• Reference: Error
  • Type: object
  • Properties:
    • error (string)
      • Example: NOT_FOUND
    • message (string)
      • Example: Resource not found

Example:

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404

Resource not found

Content type: application/json

• Reference: Error
  • Type: object
  • Properties:
    • error (string)
      • Example: NOT_FOUND
    • message (string)
      • Example: Resource not found

Example:

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Examples

cURL

curl --request PATCH \
  --url 'https://your-envoy.example.com/api/dashboards/YOUR_ID' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "description": "string",
  "yaml_content": "string",
  "status": "string"
}'

JavaScript (fetch)

const response = await fetch('https://your-envoy.example.com/api/dashboards/YOUR_ID', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "yaml_content": "string",
    "status": "string"
  }),
});
 
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);