Custom Monitors

5 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

List custom monitors

GET/api/v1/custom-monitors/deprecated

API key permissionMonitor: Read-onlymonitor:read

Returns all custom monitors accessible from the API key's workspace family tree.

Query parameters

• workspace_scopestring
• scope_from_workspace_idstring · uuid

  Required only for workspace_scope when multiple roots exist.

• name__icontainsstring
• severitystring
• workspace_idarray of string · uuid
• pageinteger

  Default 1 · Min 1

• page_sizeinteger

  Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedMonitorSummarySchema

• itemsarray of objectrequired
  Items · MonitorSummarySchema

  • idstring · uuidrequired
  • namestringrequired
  • severitystringrequired

    One of error warning

  • workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
• countintegerrequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/custom-monitors/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "severity": "error",
      "workspace": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    }
  ],
  "count": 1
}

List datastreams assigned to a monitor

GET/api/v1/custom-monitors/{monitor_id}/datastreams/deprecated

API key permissionMonitor: Read-onlymonitor:read

Path parameters

• monitor_idstring · uuidrequired

Query parameters

• pageinteger

  Default 1 · Min 1

• page_sizeinteger

  Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedDatastreamSummarySchema

• itemsarray of objectrequired
  Items · DatastreamSummarySchema

  • idstring · uuidrequired
  • namestringrequired
  • workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
• countintegerrequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/custom-monitors/{monitor_id}/datastreams/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "workspace": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    }
  ],
  "count": 1
}

Extend current list of assignments with the given datastreams

POST/api/v1/custom-monitors/{monitor_id}/datastreams/deprecated

API key permissionMonitor: Writemonitor:write

Path parameters

• monitor_idstring · uuidrequired

Request bodyrequired

application/json

Body schema

array of string · uuid UUIDListSchema

Responses

200OKapplication/json

Response schema

array of string · uuid UUIDListSchema

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/v1/custom-monitors/{monitor_id}/datastreams/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '[
    "00000000-0000-0000-0000-000000000000"
  ]'

Response200

[
  "00000000-0000-0000-0000-000000000000"
]

Unassign datastreams from a monitor

DELETE/api/v1/custom-monitors/{monitor_id}/datastreams/deprecated

API key permissionMonitor: Writemonitor:write

Path parameters

• monitor_idstring · uuidrequired

Request bodyrequired

application/json

Body schema

array of string · uuid UUIDListSchema

Responses

200OKapplication/json

Response schema

array of string · uuid UUIDListSchema

RequestcURL

curl --request DELETE 'https://{{INSTANCE}}/api/v1/custom-monitors/{monitor_id}/datastreams/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '[
    "00000000-0000-0000-0000-000000000000"
  ]'

Response200

[
  "00000000-0000-0000-0000-000000000000"
]

Discover datastreams assignable to a monitor

OPTIONS/api/v1/custom-monitors/{monitor_id}/datastreams/deprecated

API key permissionMonitor: Read-onlymonitor:read

Path parameters

• monitor_idstring · uuidrequired

Query parameters

• pageinteger

  Default 1 · Min 1

• page_sizeinteger

  Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedDatastreamSummarySchema

• itemsarray of objectrequired
  Items · DatastreamSummarySchema

  • idstring · uuidrequired
  • namestringrequired
  • workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
• countintegerrequired

RequestcURL

curl --request OPTIONS 'https://{{INSTANCE}}/api/v1/custom-monitors/{monitor_id}/datastreams/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "workspace": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    }
  ],
  "count": 1
}

Was this page helpful? Yes No