Home
Version 3
Packages (Experimental) API

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.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NyIsImVtYWlsIjoiZW1haWwtMTQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDV9.lSMzJhQb9JNT9ocwQM9ot-HCf8bb9JgrqxQ35cFeqKE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NyIsImVtYWlsIjoiZW1haWwtMTQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDV9.lSMzJhQb9JNT9ocwQM9ot-HCf8bb9JgrqxQ35cFeqKE" \
	-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-85f83d53-d2b6-44fc-987b-e2b5b05c81dd",
      "type": "bits",
      "hash": {
        "type": "sha1",
        "value": null
      },
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-08-31T21:50:05Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/packages/guid-85f83d53-d2b6-44fc-987b-e2b5b05c81dd"
        },
        "upload": {
          "href": "/v3/packages/guid-85f83d53-d2b6-44fc-987b-e2b5b05c81dd/upload",
          "method": "POST"
        },
        "download": {
          "href": "/v3/packages/guid-85f83d53-d2b6-44fc-987b-e2b5b05c81dd/download",
          "method": "GET"
        },
        "stage": {
          "href": "/v3/packages/guid-85f83d53-d2b6-44fc-987b-e2b5b05c81dd/droplets",
          "method": "POST"
        },
        "app": {
          "href": "/v3/apps/guid-43bc2de7-2729-47c7-8b34-81b3161fd6ef"
        }
      }
    },
    {
      "guid": "guid-41c6cf4e-6dbc-4fff-b2ab-972968c63c85",
      "type": "docker",
      "hash": {
        "type": "sha1",
        "value": null
      },
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-08-31T21:50:05Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/packages/guid-41c6cf4e-6dbc-4fff-b2ab-972968c63c85"
        },
        "app": {
          "href": "/v3/apps/guid-43bc2de7-2729-47c7-8b34-81b3161fd6ef"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 296d0047-48cb-425c-a5f2-f2feee240428
Content-Length: 1814
X-Content-Type-Options: nosniff