Get details of an automation

This call returns the details of a specified automation. The following are the available statuses:

  • Queued for execution - the automation run has been queued for execution, and it will proceed Sent to execution state shortly.
  • Sent to execution - the automation run has been submitted for execution, and it will proceed to Running state shortly.
  • Queued for termination - the automation run has been submitted for termination after the user aborted it and will proceed to Aborted state shortly.
  • Running - the automation run is in progress.
  • Aborted - the automation has been cancelled i.e. aborted by you.
  • Finished - the automation run has been completed successfully.
  • Failed - the automation run failed to complete.
  • Actions - the option for re-running an automation.

Request

https://api.sbgenomics.com/v2/automation/automations/{automation-id}
https://eu-api.sbgenomics.com/v2/automation/automations/{automation-id}

Example request

GET /v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8d HTTP/1.1 Host: api.sbgenomics.com X-SBG-Auth-Token: 399a7a4df28b40bba1dc4e2cf6e59a6c
curl -s -H "X-SBG-Auth-Token: 399a7a4df28b40bba1dc4e2cf6e59a6c" -H "content-type: application/json" -X GET "https://api.sbgenomics.com/v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8d"
from sevenbridges import Api

api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74',
          advance_access=True)

# send GET request to SB API
automation = api.automations.get(id='40a284d9-c0da-441c-8799-3de8d85bbd8d')

print(automation.name, automation.description, automation.archived)

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-Type
required

application/json

X-SBG-Advance-Access
required

advance

Path parameters

Name

Description

automation_id

The ID of the automation you are querying.

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Example response body

{
    "id": "40a284d9-c0da-441c-8799-3de8d85bbd8d",
    "href": "https://api.sbgenomics.com/v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8d",
    "name": "My automation",
    "description": "This is my first automation",
    "owner": "rfranklin",
    "created_by": "rfranklin",
    "created_on": "1970-01-18T18:29:46.333Z",
    "modified_on": "1970-01-18T18:29:46.333Z",
    "modified_by": "rfranklin",
    "memory_limit":1000
}

}