GEgetorchestra
Monitors

Update a monitor

Changed on

Replace a monitor's definition with the one in the body. A field left out takes its default rather than keeping its stored value, except order, which keeps the monitor's place.

put/monitors/{monitor_id}

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/monitors/{monitor_id}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:write

Path parameters

monitor_idstring uuid4 required

Monitor ID.

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Request body

namestring required
descriptionstring nullable
enabledboolean
orderinteger nullable

Response

Successful Response

monitorIdstring uuid4 required
createdAtstring required
createdBystring uuid4 required
updatedAtstring required
updatedBystring uuid4 required

Changes