It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Platform - Runners Resynchronize runners »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.5] ›RESTful API ›API reference ›Platform - Runners

Get runners

edit

Get runners

edit

Retrieves an overview of all runners.

Request

edit

GET /api/v1/platform/infrastructure/runners

Query parameters

edit
Name Type Required Description

q

string

N

An optional query to filter runners by. Maps to an Elasticsearch query_string query.

Responses

edit
200

(RunnerOverview) An overview of all runners.

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XGET https://{{hostname}}/api/v1/platform/infrastructure/runners \
-H "Authorization: ApiKey $ECE_API_KEY"
« Platform - Runners Resynchronize runners »