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.eyJ1c2VyX2lkIjoidWFhLWlkLTIwOCIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NDh9.D5N4TTy21EwCVOBAS3VayZ-eALrcRz9VJ10aONJgCpY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwOCIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NDh9.D5N4TTy21EwCVOBAS3VayZ-eALrcRz9VJ10aONJgCpY" \
	-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-c6e6bcd3-34ec-410a-8886-041662f0307c",
      "type": "bits",
      "hash": null,
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-03-05T19:15:48Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-c6e6bcd3-34ec-410a-8886-041662f0307c"
        },
        "upload": {
          "href": "/v3/packages/guid-c6e6bcd3-34ec-410a-8886-041662f0307c/upload"
        },
        "app": {
          "href": "/v3/apps/guid-9b077eb3-9fa1-4f7a-9a1a-3636a5e8f64c"
        }
      }
    },
    {
      "guid": "guid-3bfaebbb-6f31-485a-9c0d-9478f58b0f03",
      "type": "docker",
      "hash": null,
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-03-05T19:15:48Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-3bfaebbb-6f31-485a-9c0d-9478f58b0f03"
        },
        "app": {
          "href": "/v3/apps/guid-9b077eb3-9fa1-4f7a-9a1a-3636a5e8f64c"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 612bdc1e-9dc3-4558-9719-25d3189e6736
Content-Length: 1346
X-Content-Type-Options: nosniff