GuidesAPIDatasets HubRelease Notes
API Reference
CGC

Get details of a file within a volume

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

This call lists the details of a file (object) in a specific volume. The volume is specified as volume_id and consists of the owner and name of a volume (for example rfranklin/my-first-volume).

Request

https://cgc-api.sbgenomics.com/v2/storage/volumes/{volume_id}/{object_id}

Example request

GET /v2/storage/volumes/rfranklin/my-first-volume/{object_id} HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "Content-type: application/json" -X GET "https://cgc-api.sbgenomics.com/storage/volumes/rfranklin/my-first-volume/{object_id}"

Header Fields

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

Path parameters

KeyData type of valueDescription of value
volume_id
required		StringThe volume that you want to query, which consists of username of the volume owner and volume name, for example rfranklin/my-first-volume.
object_id
required		StringThis is the href from the request to list the contents of a volume.

Response

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

Example response body

{
  "href": "https://gcp-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/object?location=20.intervals",
  "location": "20.intervals",
  "volume": "rfranklin/my-first-volume",
  "type": "gcs",
  "metadata": {
    "bucket": "example-bucket",
    "contentType": "binary/octet-stream",
    "crc32c": "P1RVmQ==",
    "etag": "CNjexsvWvc0CEAE=",
    "generation": 1463468676135000,
    "id": "example-bucket/input-files/20.intervals/1463468676135000",
    "kind": "storage#object",
    "md5Hash": "0SgvPL/j5a/TOHXpzkfX0A==",
    "mediaLink": "https://www.googleapis.com/download/storage/*********",
    "metageneration": 1,
    "name": "input-files/20.intervals",
    "selfLink": "https://www.googleapis.com/storage/v1/b/example-bucket/o/input-files%2F20.intervals",
    "size": 9,
    "storageClass": "STANDARD",
    "timeCreated": {
      "value": 1466668676132,
      "dateOnly": false,
      "timeZoneShift": 0
    },
    "updated": {
      "value": 1466668676132,
      "dateOnly": false,
      "timeZoneShift": 0
    },
    "timeStorageClassUpdated": "2016-06-23T07:57:56.132Z"
  }
}

Interpreting the response body

  • href: Use the information contained in the href to make another request to obtain more details about a specific object within a volume.
Language