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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NSIsImVtYWlsIjoiZW1haWwtMTc3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE2OTl9.fb2QKEJRW63BG0XxGqLaJpDA_53U0wlY7cSVk26tFgM
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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NSIsImVtYWlsIjoiZW1haWwtMTc3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE2OTl9.fb2QKEJRW63BG0XxGqLaJpDA_53U0wlY7cSVk26tFgM" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: dbe03c62-9e9a-4989-9c53-15941f5c844b
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-9935d081-bb11-4448-aa03-fe593251e6c3",
      "type": "bits",
      "hash": null,
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-02-13T22:34:59Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-9935d081-bb11-4448-aa03-fe593251e6c3"
        },
        "upload": {
          "href": "/v3/packages/guid-9935d081-bb11-4448-aa03-fe593251e6c3/upload"
        },
        "app": {
          "href": "/v3/apps/guid-14c12e8a-a728-4433-8bca-215de66f3121"
        },
        "space": {
          "href": "/v2/spaces/2325744d-7d5c-479f-ae13-b006625842a4"
        }
      }
    },
    {
      "guid": "guid-2acc95ed-d165-4033-b683-079ef09a1e97",
      "type": "docker",
      "hash": null,
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-02-13T22:34:59Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-2acc95ed-d165-4033-b683-079ef09a1e97"
        },
        "app": {
          "href": "/v3/apps/guid-600e65c9-574f-497b-b5ed-b2a1616e6b73"
        },
        "space": {
          "href": "/v2/spaces/2325744d-7d5c-479f-ae13-b006625842a4"
        }
      }
    }
  ]
}