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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzIiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI5MDM4Njk4fQ.1mEDn-ViJf7nSXup47agf22zDBir2Zw7qiR3c-3TA2g
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzIiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI5MDM4Njk4fQ.1mEDn-ViJf7nSXup47agf22zDBir2Zw7qiR3c-3TA2g" \
	-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-9f73ed12-62ac-45d5-b9fe-50943fc98d4b",
      "type": "bits",
      "hash": null,
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-04-07T19:11:38Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-9f73ed12-62ac-45d5-b9fe-50943fc98d4b"
        },
        "upload": {
          "href": "/v3/packages/guid-9f73ed12-62ac-45d5-b9fe-50943fc98d4b/upload",
          "method": "POST"
        },
        "app": {
          "href": "/v3/apps/guid-bcacf2dd-5b7a-4524-8968-471d6b1efdce"
        }
      }
    },
    {
      "guid": "guid-d311fe0c-3076-4735-bbe1-40551f78c9b3",
      "type": "docker",
      "hash": null,
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-04-07T19:11:38Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-d311fe0c-3076-4735-bbe1-40551f78c9b3"
        },
        "app": {
          "href": "/v3/apps/guid-bcacf2dd-5b7a-4524-8968-471d6b1efdce"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 28ec0c5a-4331-4c56-88b9-7ddfb63dc13b
Content-Length: 1374
X-Content-Type-Options: nosniff