Create a new automation

This call creates a new automation.

Request

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

Example request

POST v2/automation/automations
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259720f72
curl -X POST \
  https://api.sbgenomics.com/v2/automation/runs \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Advance-Access: advance' \
  -H 'X-SBG-Auth-Token: b04aa2a2e98348a1a3a75ca677ea7fd7'
  "
    ]
}
'
from sevenbridges import Api

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

# send POST request to SB API
automation = api.automations.create(
    name='My new automation',
    description='This is a description for my new automation.'
)

print(automation.id)

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

###Request body
In the body, you should enter a list of key-value pairs. The keys, and the values they take, are described in the following table.

Name

Data type

Description

name
required

string

The name of the new automation you are creating.

description
required

string

The description for the new automation.

secret_settings

dictionary of key-value pairs

Use these settings to override default automation secret settings.

This will not be shown in an execution log or automation run info.

billing_group

string

Specify the billing group this automation will be attached to.

memory_limit

integer

Set the memory limit for the automation, specified in MB.

The default value is 500MB while the maximum allowed is 4000MB.

If no specific limit is set for a code package or automation run, this value will be used.

project_based

string

Set to true to allow running automations directly from within your projects.

Example request body

{
 "name":"My new automation",
 "description":"This is a description for my new automation."
}

Response

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

Example response body

{
  "name": "Automation 1",
  "package": "40a284d9-c0da-441c-8799-3de8d85bbd8d",
  "inputs":"{
        "x": 1,
        "y": 2,
        "z": 3
    },
  "settings":"null",  "secret_settings":""
}}