Launches

Launches Description: A launch represents an execution of a specific Workflow in a Bot Runner.

Get Launch Info

This returns detailed information on a particular Workflow launch. If the launch ended with an error, an additional key error_details is returned.

SecuritybearerAuth
Request
path Parameters
id
required
string

Launch ID

Responses
200

Success

get/launch/{id}
Response samples
application/json
{
  • "workflow_id": "someID",
  • "runner_id": "some runner ID",
  • "error_details": {
    },
  • "id": "6114e341038ca47aa488d942",
  • "type": "manual",
  • "status": "completed-successfully",
  • "account_email": "robot@electoneek.com",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "logs_enabled": true,
  • "output_data": { }
}

Stop Launch

This stops the selected launch.

SecuritybearerAuth
Request
path Parameters
id
required
string

Launch ID

Request Body schema: application/json
is_hardstop
boolean
Responses
201

Created

post/launch/{id}/stop
Request samples
application/json
{
  • "is_hardstop": true
}

Cancel Launch in a Queue

This cancels a scheduled Launch that is currently in a queue.

SecuritybearerAuth
Request
path Parameters
id
required
string

Launch ID

Responses
201

Created

post/launch/{id}/cancel
Copyright © ElectroNeek 2019-2023. All right reserved.