Edit an automation

This call edits the parameters of the existing automation template. You need to have admin or write permissions for an automation in order to be able to edit it.

Request

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

Example request

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

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

automation = api.automations.get(id='40a284d9-c0da-441c-8799-3de8d85bbd8d')

# modify automation properties
automation.name = 'My edited name for the automation'
automation.description = 'This is a description for my new automation.'

# send PATCH request to SB API
automation.save()

print(automation.name)

Header Fields

Key

Description of value

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-type
required

application/json

X-SBG-Advance-Access
required

advance

Path parameters

Key

Data type

Description

automation-id
required

String

The ID of the automation template you are editing.

Request body

Name

Data type

Description

name

string

Specify the new name for the automation template.

description

string

Change the description for the automation template.

secret_settings

dictionary of key-value pairs

Change the automation settings (and override default automation settings).

billing_group

string

Change the billing group this automation template will be attached to.

memory_limit

integer

Edit the memory limit for the automation entity, 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 edited name for the 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

{
    "id": "8d05aedc-9304-4cc8-bc86-da7406870790",
    "href": "https://api.sbgenomics.com/v2/automation/automations/8d05aedc-9304-4cc8-bc86-da3445670790",
    "name": "My edited name for the automation",
    "description": "This is a description for my new automation.",
    "owner": "rfranklin",
    "created_by": "rfranklin",
    "created_on": "2019-02-01T13:32:05.000Z",
    "modified_on": "2019-02-01T13:32:05.794335",
    "modified_by": "rfranklin"
}