monitors

Get a monitor

Retrieve a previously created monitor by id.

get/v1/monitors/{monitorId}

Request

  • Base URL: https://api.olostep.com
  • URL: https://api.olostep.com/v1/monitors/{monitorId}
  • Auth: HTTP bearer

Path parameters

monitorIdstring required

Query parameters

include_total_count'0' | '1' | 'true' | 'false'
include-diagram'1' | 'true'

Response

Default Response

idstring required
objectstring
querystring required
output_schemaobject nullable
status'provisioning' | 'active' | 'paused' | 'failed' | 'deleted' required
error_messagestring nullable
metadataobject
creatednumber required
updatednumber
total_countnumber
mermaid_diagramstring

Changes

No recorded changes to this operation across all 3 revisions of this API.