List export jobs

📘

When exporting a file from the Platform to an attached volume, export is possible only to a volume that is in the same location (cloud provider and region) as the project from which the file is being exported.

This call lists export jobs initiated by particular user.

Note that when you export a file from a project on the Platform into a volume, you write to your cloud storage bucket.

Learn more about using the Volumes API for Amazon S3.

Request

https://api.sbgenomics.com/v2/storage/exports
https://eu-api.sbgenomics.com/v2/storage/exports

Example request

GET /v2/storage/exports HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
Content-type: application/json
curl -s -H "X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96" -H "Content-Type: application/json" -X GET "https://api.sbgenomics.com/v2/storage/exports"
from sevenbridges import Api

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

# send GET request to SB API
exports = api.exports.query()

for export in exports:
    print(export.id, export.state)

Header Fields

Key

Description of value

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-type
required

application/json

Response

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

Example response body

{
  "href": "https://api.sbgenomics.com/v2/storage/exports?offset=0&limit=50",
  "items": [
    {
      "href": "https://api.sbgenomics.com/v2/storage/exports/19K01S2JNGdsI8pSV1IeLoh2eM0A60hK",
      "id": "19K01S2JNGdsI8pSV1IeLoh2eM0A60hK",
      "state": "FAILED"
    },
    {
      "href": "https://api.sbgenomics.com/v2/storage/exports/FudXgy8zXOg1UJUidCvzh7oIVRTK3LKY",
      "id": "FudXgy8zXOg1UJUidCvzh7oIVRTK3LKY",
      "state": "COMPLETED"
    },
    {
      "href": "https://api.sbgenomics.com/v2/storage/exports/gkfLPQaEuwAD1DnsO8bjWo0B8j0aJK4M",
      "id": "gkfLPQaEuwAD1DnsO8bjWo0B8j0aJK4M",
      "state": "COMPLETED"
    },
    {
      "href": "https://api.sbgenomics.com/v2/storage/exports/hcHlrTT3oyO3kitzSqJeGq7MImi0noMF",
      "id": "hcHlrTT3oyO3kitzSqJeGq7MImi0noMF",
      "state": "COMPLETED"
    },
    {
      "href": "https://api.sbgenomics.com/v2/storage/exports/z4ebtofuNMPRBZls6WC9pG7KlMgB5L0C",
      "id": "z4ebtofuNMPRBZls6WC9pG7KlMgB5L0C",
      "state": "COMPLETED"
    },
    {
      "href": "https://api.sbgenomics.com/v2/storage/exports/ZltlOYd7CReLihnHse4YDQNqDrx92Xy0",
      "id": "ZltlOYd7CReLihnHse4YDQNqDrx92Xy0",
      "state": "FAILED"
    }
  ],
  "links": []
}