A newer version is available. For the latest information, see the
current release documentation.
Search runners
editSearch runners
editRetrieves runners that match a given query.
Request
editPOST /api/v1/platform/infrastructure/runners/_search
Request body
edit(SearchRequest
) The optional search request to execute. If not supplied then all runners are matched.
Responses
edit-
200
-
An overview of runners that matched the given search query.
-
400
-
The search request failed. (code:
runners.search_failed
)Headers
-
x-cloud-error-codes
(string
; allowed values: [runners.search_failed
]) - The error codes associated with the response
-
Request example
editcurl -XPOST https://{{hostname}}/api/v1/platform/infrastructure/runners/_search \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "from" : 0, "query" : { "bool" : { "filter" : [ null ], "minimum_should_match" : 0, "must" : [ null ], "must_not" : [ null ], "should" : [ null ] }, "exists" : { "field" : "string" }, "match" : { "some_property" : { "analyzer" : "string", "minimum_should_match" : 0, "operator" : "string", "query" : "string" } }, "match_all" : {}, "match_none" : {}, "nested" : { "path" : "string", "query" : null, "score_mode" : "string" }, "prefix" : { "some_property" : { "boost" : 0.1, "value" : "string" } }, "query_string" : { "allow_leading_wildcard" : true, "analyzer" : "string", "default_field" : "string", "default_operator" : "string", "query" : "string" }, "range" : { "some_property" : { "boost" : 0.1, "format" : "string", "gt" : {}, "gte" : {}, "lt" : {}, "lte" : {}, "time_zone" : "string" } }, "term" : { "some_property" : { "value" : {} } } }, "size" : 0, "sort" : [ {} ] } '