Edit an automation entity

This call edits an automation entity. You can use this call to change the automation name, the billing group, or the secret settings.

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/1956d4cf-2705-4e9d-aeaa-2513f27957db HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 697195688ad14d5bb74d5d5c4f536d3b
X-SBG-Advance-Access: advance
Content-Type: application/json

{
  "name": "New automation name",
  "billing_group": "324d0471-b2a6-40da-afcf-637aa1cdee45"
}
curl --location --request PATCH 'https://api.sbgenomics.com/v2/automation/automations/1956d4cf-2706-4e9d-aeaa-2513f27957db' \
--header 'X-SBG-Auth-Token: 697195687ad14d5bb74d5d5c4f536d3b' \
--header 'X-SBG-Advance-Access: advance' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "New automation name",
  "billing_group": "324d0471-b2a6-40da-afcf-637aa1cdee45"
}

 '
from sevenbridges import Api

api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74',
          advance_access=True)
automation = api.automations.get(id='1956d4cf-2705-4e9d-aeaa-2513f27957db')

# edit an automation entity
automation.name = 'New automation name'
automation.billing_group = '324d0471-b2a6-40da-afcf-637aa1cdee45'

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

print(automation.name, automation.billing_group)

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

Name

Data type

Description

name
required

string

Change the new name for the automation entity.

billing_group

string

Specify a different billing group for this automation entity.

secret_settings

dictionary of key-value pairs

Specify different secret settings).

Path parameters

Name

Description

automation_id

The ID of the automation you are editing.

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": "1956d4cf-2706-4e89d-aeaa-2513f27957db",
    "href": "https://api.sbgenomics.com/v2/automation/automations/1956d4cf-2706-4e9d-aeaa-2513f27957db",
    "name": "New automation name",
    "owner": "rfranklin",
    "archived": false,
    "billing_group": "324d0471-b2a6-40da-afcf-637aa1cdee45",
    "created_by": "rfranklin",
    "created_on": "2019-10-03T09:39:43.000Z",
    "modified_on": "2020-01-14T12:00:56.496307",
    "modified_by": "rfranklin"
}