Packages (Experimental) API

List all Packages

GET /v3/packages

Request

Route

GET /v3/packages?page=1&per_page=2

Parameters

Name	Description	Valid Values	Example Values
page	Page to display	>= 1
per_page	Number of results per page	1-5000

page: 1
per_page: 2

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NCIsImVtYWlsIjoiZW1haWwtODJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLnJlYWQiLCJjbG91ZF9jb250cm9sbGVyLndyaXRlIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4Mn0.HT2DxVnNWH4xjDRYzaaHmVoJk0v9LSUbpBhEnOiQlEw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NCIsImVtYWlsIjoiZW1haWwtODJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLnJlYWQiLCJjbG91ZF9jb250cm9sbGVyLndyaXRlIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4Mn0.HT2DxVnNWH4xjDRYzaaHmVoJk0v9LSUbpBhEnOiQlEw" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/packages?page=1&per_page=2"
    },
    "last": {
      "href": "/v3/packages?page=2&per_page=2"
    },
    "next": {
      "href": "/v3/packages?page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-d22b6914-6f4c-46e1-b146-4a8549ba4a00",
      "type": "bits",
      "data": {
        "error": null,
        "hash": {
          "type": "sha1",
          "value": null
        }
      },
      "state": "AWAITING_UPLOAD",
      "created_at": "2015-12-22T18:28:02Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/packages/guid-d22b6914-6f4c-46e1-b146-4a8549ba4a00"
        },
        "upload": {
          "href": "/v3/packages/guid-d22b6914-6f4c-46e1-b146-4a8549ba4a00/upload",
          "method": "POST"
        },
        "download": {
          "href": "/v3/packages/guid-d22b6914-6f4c-46e1-b146-4a8549ba4a00/download",
          "method": "GET"
        },
        "stage": {
          "href": "/v3/packages/guid-d22b6914-6f4c-46e1-b146-4a8549ba4a00/droplets",
          "method": "POST"
        },
        "app": {
          "href": "/v3/apps/guid-aa29346f-211c-489a-a172-098f992ffae0"
        }
      }
    },
    {
      "guid": "guid-168d316a-7dc3-472f-b3b3-c4ad9c01cbb3",
      "type": "docker",
      "data": {
        "image": "http://location-of-image.com"
      },
      "state": "READY",
      "created_at": "2015-12-22T18:28:02Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/packages/guid-168d316a-7dc3-472f-b3b3-c4ad9c01cbb3"
        },
        "app": {
          "href": "/v3/apps/guid-aa29346f-211c-489a-a172-098f992ffae0"
        }
      }
    }
  ]
}

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
X-Runtime: 0.012516
Content-Length: 1764