ElectroNeek Documentation

Esta página ainda não foi traduzida para o português, por isso é exibida em inglês.

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

{region} pode ser: na, cis, apac, latam, emea

Experimente

Enviado do seu navegador diretamente para a API — nada passa por este site, e o token API fica apenas nesta aba.
Parâmetros de consulta
cURL
curl --request GET \
  --url 'https://api.na.electroneek.com/v1/orchestrator/bot-runners'

Autenticação

Use um token API da página Orquestrador → Integrações. Envie-o como token bearer: Authorization: Bearer <token>.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
statusstring (ready, in_progress, offline)nãoIt filters Bot Runners by status
login_asstringnãoIt filters logged users by email, e.g., robot@electroneek.com
versionstringnãoIt filters Bot Runners by version, e.g., 8.0.0
idsarray of stringnãoIt filters by Bot Runner IDs.
namestringnãoIt filters Bot Runners by the name, .e.g, MY-BOT-RUNNER-1

Resposta

200API returns the list of Bot Runners matching the filter criteria.
Corpo da resposta
object
listarray of objects
object
iduuidobrigatório

ID of the Bot Runner

namestringobrigatório

Name of the Bot Runner

statusstring (ready, in_progress, offline)obrigatório

Status of the Bot Runner

versionstringobrigatório

Version of the Bot Runner

login_asobjectobrigatório

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_namestringobrigatório

Name of the computer where Bot Runner is installed.

Atualizado
AutenticaçãoGet info of a Bot Runner