Archive an automation

This call archives an automation.

Request

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

Example request

POST v2/automation/automations/595e5a46-8b2b-4d7a-ae7d-f043e2d9b020/actions/archive
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259720f72
curl -X POST \
  https://api.sbgenomics.com/v2/automation/automations/595e5a46-8b2b-4d7a-ae7d-f043e2d9b020/actions/archive \
   -H 'Host: api.sbgenomics.com' \
   -H 'X-SBG-Advance-Access: advance' \
   -H 'X-SBG-Auth-Token: 46bd0e5112f114e9b8e0d0aa0f295837d' \
from sevenbridges import Api

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

automation = api.automations.get(id='595e5a46-8b2b-4d7a-ae7d-f043e2d9b020')

# send POST request to SB API
automation.archive()

print(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
required

The ID of the automation you are archiving.

Response

{
    "id": "595e5a46-8b2b-4d7a-ae7d-f043e2d9b020",
    "href": "https://api.sbgenomics.com/v2/automation/automations/595e5a46-8b2b-4d7a-ae7d-f043e2d9b020",
    "name": "My automation",
    "owner": "rfranklin",
    "archived": true,
    "billing_group": "82d2bbed-b35f-4cf5-9924-ddd392861d60",
    "created_by": "rfranklin",
    "created_on": "2019-09-05T11:44:07.000Z",
    "modified_on": "2019-09-23T11:43:06.742060",
    "modified_by": "rfranklin"
}

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