ElectroNeek Documentation

Diese Seite wurde noch nicht ins Deutsche übersetzt und wird daher auf Englisch angezeigt.

Get a list of all Bot Runners

This returns the list of all Bot Runners that are connected to Orchestrator. You can filter the result by status, logged-in user, Bot Runner version, ID, or name.


gethttps://api.{region}.electroneek.com/v1/orchestrator/bot-runners

Mögliche Werte für {region}: na, cis, apac, latam, emea

Ausprobieren

Wird direkt von Ihrem Browser an die API gesendet – nichts läuft über diese Website, und das API-Token bleibt nur in diesem Tab.
Query-Parameter
cURL
curl --request GET \
  --url 'https://api.na.electroneek.com/v1/orchestrator/bot-runners'

Authentifizierung

Verwenden Sie ein API-Token von der Seite Orchestrator → Integrationen. Senden Sie es als Bearer-Token: Authorization: Bearer <token>.

Query-Parameter

NameTypErforderlichBeschreibung
statusstring (ready, in_progress, offline)neinIt filters Bot Runners by status
login_asstringneinIt filters logged users by email, e.g., robot@electroneek.com
versionstringneinIt filters Bot Runners by version, e.g., 8.0.0
idsarray of stringneinIt filters by Bot Runner IDs.
namestringneinIt filters Bot Runners by the name, .e.g, MY-BOT-RUNNER-1

Antwort

200API returns the list of Bot Runners matching the filter criteria.
Response-Body
object
listarray of objects
object
iduuiderforderlich

ID of the Bot Runner

namestringerforderlich

Name of the Bot Runner

statusstring (ready, in_progress, offline)erforderlich

Status of the Bot Runner

versionstringerforderlich

Version of the Bot Runner

login_asobjecterforderlich

Organization's data to which the API key belongs. Starting from the version 7.0, we replaced the login-password connection of Orchestrator to Bot Runner with tokens

object
typestring
valuestring
host_namestringerforderlich

Name of the computer where Bot Runner is installed.

Aktualisiert