Packages (Experimental) API

List all Packages

GET /v3/packages

Fields

Name	Description	Default	Valid Values	Example Values

Parameters

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNyIsImVtYWlsIjoiZW1haWwtOTdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLnJlYWQiLCJjbG91ZF9jb250cm9sbGVyLndyaXRlIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3Mn0.y2UcPyQcRsbm0vcfTMLKhd1AJMN2GvAU_NJCdASUsPQ
Host: example.org
Cookie: 

Route

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

Query Parameters

page: 1
per_page: 2

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b4e1face-5638-4616-8b75-fc7e44ce6d1a
Content-Length: 1542
X-Content-Type-Options: nosniff

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-967f6de6-71bd-4c20-9c18-f00a50cbdd0f",
      "type": "bits",
      "hash": null,
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-01-27T19:14:32Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-967f6de6-71bd-4c20-9c18-f00a50cbdd0f"
        },
        "upload": {
          "href": "/v3/packages/guid-967f6de6-71bd-4c20-9c18-f00a50cbdd0f/upload"
        },
        "app": {
          "href": "/v3/apps/guid-d1a0236b-0a71-43ea-ac93-7911c09c9ec9"
        },
        "space": {
          "href": "/v2/spaces/7e7a4c01-7f7d-4862-ac3b-b88de6c4857f"
        }
      }
    },
    {
      "guid": "guid-4b054a4f-b206-4a2b-be06-3de7c09b60de",
      "type": "docker",
      "hash": null,
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-01-27T19:14:32Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-4b054a4f-b206-4a2b-be06-3de7c09b60de"
        },
        "app": {
          "href": "/v3/apps/guid-065f4200-d5e5-4bde-9c12-74f09552a6f1"
        },
        "space": {
          "href": "/v2/spaces/7e7a4c01-7f7d-4862-ac3b-b88de6c4857f"
        }
      }
    }
  ]
}