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

Body

Name	Description	Default	Valid Values	Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU2IiwiZW1haWwiOiJlbWFpbC01NEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2NjMzODk4fQ.ir8wpVtP1cCAAYNUEVPELeVm2GstUfhZOD6MjHLwDG8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU2IiwiZW1haWwiOiJlbWFpbC01NEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2NjMzODk4fQ.ir8wpVtP1cCAAYNUEVPELeVm2GstUfhZOD6MjHLwDG8" \
	-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-3fa5904f-fe62-4c4f-9701-2a4d58716dac",
      "type": "bits",
      "hash": null,
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-03-10T23:11:38Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-3fa5904f-fe62-4c4f-9701-2a4d58716dac"
        },
        "upload": {
          "href": "/v3/packages/guid-3fa5904f-fe62-4c4f-9701-2a4d58716dac/upload"
        },
        "app": {
          "href": "/v3/apps/guid-57574fe7-fbd0-48dd-98e4-ebdf3e5af4f2"
        }
      }
    },
    {
      "guid": "guid-555c1fb0-c51e-449a-97a9-80a9a93a250d",
      "type": "docker",
      "hash": null,
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-03-10T23:11:38Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-555c1fb0-c51e-449a-97a9-80a9a93a250d"
        },
        "app": {
          "href": "/v3/apps/guid-57574fe7-fbd0-48dd-98e4-ebdf3e5af4f2"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: cc23cddf-ad15-485c-b056-ea826700733c
Content-Length: 1346
X-Content-Type-Options: nosniff