GuidesAPIDatasets HubRelease Notes
API Reference
CGC

List export jobs

get https://cgc-api.sbgenomics.com/v2

📘

When exporting a file from the CGC 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 CGC into a volume, you write to your cloud storage bucket on Amazon Web Services.

Learn more about using the Volumes API for Amazon S3 and Google Cloud Storage.

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

Request

Example request

GET /v2/storage/exports HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
Content-type: application/json

curl -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "Content-Type: application/json" -X GET "https://cgc-api.sbgenomics.com/v2/storage/exports"

Header Fields

KeyDescription of value
X-SBG-Auth-Token
required		Your CGC authentication token.
Content-type
required		application/json

Response

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

Example response body 

{
  "href": "https://cgc-api.sbgenomics.com/v2/storage/exports?offset=0&limit=50",
  "items": [
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/22P01S2JNGdsI8pEN9IeLoh2eN9A61hK",
      "id": "22P01S2JNGdsI8pEN9IeLoh2eN9A61hK",
      "state": "FAILED"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/FMxxKDYZMgWdm3JxYECASfFfNhtRSPtp",
      "id": "FMxxKDYZMgWdm3JxYECASfFfNhtRSPtp",
      "state": "COMPLETED"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/ut6FfmTq2Q8SvGp4qarvsZFjH9gqXX73",
      "id": "2nNtQ85VYLSk1s2pl4AA2Rd53cFXbU6r",
      "state": "COMPLETED"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/bdXqE72MFESKtBFMMHAmmt844KHCdkJZ",
      "id": "bdXqE72MFESKtBFMMHAmmt844KHCdkJZ",
      "state": "COMPLETED"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/btdjdXnsuBEscQnfHUYgRMuDyfB2B2NC",
      "id": "btdjdXnsuBEscQnfHUYgRMuDyfB2B2NC",
      "state": "COMPLETED"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/C4fbaFnPERw6xju7cM5g2EVHGBJfATe3",
      "id": "C4fbaFnPERw6xju7cM5g2EVHGBJfATe3",
      "state": "COMPLETED"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/bC6Km3yGzRvCq72cxFhVa4q2Vaz4jZh6",
      "id": "bC6Km3yGzRvCq72cxFhVa4q2Vaz4jZh6",
      "state": "FAILED"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/HHW7aNG8rF4PJQxkCYmk35bXeLzeRfGq",
      "id": "HHW7aNG8rF4PJQxkCYmk35bXeLzeRfGq",
      "state": "FAILED"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/3Y8AgGut4jX7VrHT9SxuFSRfwjrxTsZx",
      "id": "3Y8AgGut4jX7VrHT9SxuFSRfwjrxTsZx",
      "state": "FAILED"
    },
   }
    <snip>
  ],
  "links": []
}

📘

For the sake of brevity, we've omitted some jobs.

Language