Get all monitors

GET

/monitors

GET

/monitors

$ curl https://api.getpostman.com/monitors \
>      -H "x-api-key: <apiKey>"

1 {
2   "monitors": [
3     {
4       "id": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
5       "name": "Test Monitor",
6       "active": true,
7       "uid": "12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
8       "owner": 12345678,
9       "collectionUid": "12345678-d35c5bfa-380e-4e98-9052-4eaf3bd0f14a",
10       "environmentUid": "12345678-9ce0605e-e7cb-40dc-8074-2f6a69252905"
11     },
12     {
13       "id": "1e6b6cb7-f13d-4000-acb7-0695757174a8",
14       "name": "API Test",
15       "active": true,
16       "uid": "87654321-1e6b6cb7-f13d-4000-acb7-0695757174a8",
17       "owner": 87654321,
18       "collectionUid": "87654321-2f5e0f30-15f9-4c8a-9371-bb4402149abb",
19       "environmentUid": "87654321-da11b6bf-1856-4625-ade2-46843b8eb31c"
20     },
21     {
22       "id": "3d08e460-b58f-4f46-9dbb-018c57760864",
23       "name": "Billing",
24       "active": false,
25       "uid": "56781234-3d08e460-b58f-4f46-9dbb-018c57760864",
26       "owner": 56781234,
27       "collectionUid": "56781234-b79c429b-b347-4b9c-a969-9cc3e1349f68",
28       "environmentUid": "56781234-ec29504a-a305-47b2-9c73-8b0dcd6ddd61"
29     },
30     {
31       "id": "90e01576-3ec4-4245-a327-e56b78becdce",
32       "name": "Testing Monitor",
33       "active": true,
34       "uid": "12345678-90e01576-3ec4-4245-a327-e56b78becdce",
35       "owner": 12345678,
36       "collectionUid": "12345678-ecfd0f2c-cf60-4935-b2ed-b65c58d2910c",
37       "environmentUid": "12345678-106dabbe-324c-488f-b628-c9f45033dcc7"
38     },
39     {
40       "id": "5c8ff94d-ae04-4f23-812c-d428fa72bc43",
41       "name": "API Test 2",
42       "active": false,
43       "uid": "87654321-5c8ff94d-ae04-4f23-812c-d428fa72bc43",
44       "owner": 87654321,
45       "collectionUid": "87654321-01c3b7c7-bf1e-47ab-8d57-0f9f950dca65",
46       "environmentUid": "87654321-2ff3607d-2bdc-49a4-91af-40b0f48a0c77"
47     }
48   ],
49   "meta": {
50     "nextCursor": "",
51     "limit": 25
52   }
53 }

Gets all monitors.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

workspacestringOptional

Return only results found in the given workspace ID.

activebooleanOptionalDefaults to false

If true, return only active monitors.

ownerintegerOptional

Return only results that belong to the given user ID.

collectionUidstringOptionalformat: "uid"

Filter the results by a collection's unique ID.

environmentUidstringOptionalformat: "uid"

Filter the results by an environment's unique ID.

cursorstringOptional

The pointer to the first record of the set of paginated results. To view the next response, use the nextCursor value for this parameter.

limitintegerOptional<=25Defaults to 25

The maximum number of rows to return in the response, up to a maximum value of 25. Any value greater than 25 returns a 400 Bad Request response.

Response

Successful Response

monitorslist of objects

A list of monitors.

metaobject

The response's meta information for paginated results.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error