Get all runner instances

GET

/runners/:runnerId/instances

GET

/runners/:runnerId/instances

$ curl https://api.getpostman.com/runners/1f08d6ba-c377-4ca0-be80-af81daf8fef9/instances \
>      -H "x-api-key: <apiKey>"

1 {
2   "meta": {
3     "model": "runnerInstance",
4     "action": "find",
5     "url": "https://testing.example.com/runners/1f08d6ba-c377-4ca0-be80-af81daf8fef9/instances"
6   },
7   "data": [
8     {
9       "id": "Rtesting-78b4f9c59c-5c7mx|b5862804ba|1.23.0|Linux",
10       "hostname": "testing-78b4f9c59c-5c7mx",
11       "uniqueId": "b5862804ba",
12       "cliVersion": "1.23.0",
13       "osType": "Linux",
14       "runnerId": "1f08d6ba-c377-4ca0-be80-af81daf8fef9",
15       "lastPingedAt": "2025-11-06T14:59:53.000Z"
16     },
17     {
18       "id": "Rtesting-78b4f9c59c-bdjdr|f1b9f8f94a|1.23.0|Linux",
19       "hostname": "testing-78b4f9c59c-bdjdr",
20       "uniqueId": "f1b9f8f94a",
21       "cliVersion": "1.23.0",
22       "osType": "Linux",
23       "runnerId": "1f08d6ba-c377-4ca0-be80-af81daf8fef9",
24       "lastPingedAt": "2025-11-06T15:30:51.000Z"
25     },
26     {
27       "id": "Rtesting-78b4f9c59c-g85wn|b35d23de98|1.23.0|Linux",
28       "hostname": "testing-78b4f9c59c-g85wn",
29       "uniqueId": "b35d23de98",
30       "cliVersion": "1.23.0",
31       "osType": "Linux",
32       "runnerId": "1f08d6ba-c377-4ca0-be80-af81daf8fef9",
33       "lastPingedAt": "2025-11-06T15:33:35.000Z"
34     },
35     {
36       "id": "Rtesting-78b4f9c59c-shf48|cd40b93f88|1.23.0|Linux",
37       "hostname": "testing-78b4f9c59c-shf48",
38       "uniqueId": "cd40b93f88",
39       "cliVersion": "1.23.0",
40       "osType": "Linux",
41       "runnerId": "1f08d6ba-c377-4ca0-be80-af81daf8fef9",
42       "lastPingedAt": "2025-11-06T15:33:35.000Z"
43     }
44   ]
45 }

Gets all instances of the runner polling Postman for upcoming monitor runs. Instances are runner executions that share the same runner ID and key.

Note:

You can get a runner’s ID in the Postman UI if you have an Admin or Super Admin role. To do this, click Team > Team Settings in Postman, then click Runners. Click the runner you want to get the ID of, then copy its ID from the URL.

Gets all instances of the runner polling Postman for upcoming monitor runs. Instances are runner executions that share the same runner ID and key. **Note:** You can get a runner's ID in the Postman UI if you have an Admin or Super Admin role. To do this, click **Team > Team Settings** in Postman, then click **Runners**. Click the runner you want to get the ID of, then copy its ID from the URL.

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)>.

Path parameters

runnerIdstringRequired

The runner's ID.

Query parameters

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.

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.

Response

Successful Response

metaobject

The response's meta information for paginated results.

datalist of objects

A list of all runner instances.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error