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.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NiIsImVtYWlsIjoiZW1haWwtMTU4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5Njh9.EUtAweEbS_8RQnXRR0CKaAMy_I6W8Chu30-vS-MhJpU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NiIsImVtYWlsIjoiZW1haWwtMTU4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5Njh9.EUtAweEbS_8RQnXRR0CKaAMy_I6W8Chu30-vS-MhJpU" \
	-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-e8ca635a-98ea-4277-b1be-c4b96a4d7f1e",
      "type": "bits",
      "hash": null,
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-03-18T22:52:48Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-e8ca635a-98ea-4277-b1be-c4b96a4d7f1e"
        },
        "upload": {
          "href": "/v3/packages/guid-e8ca635a-98ea-4277-b1be-c4b96a4d7f1e/upload"
        },
        "app": {
          "href": "/v3/apps/guid-3edd2a0e-dcac-43f5-bd3b-a1536067e950"
        }
      }
    },
    {
      "guid": "guid-78c7ad0d-bb94-4e19-8442-6c71852ac1f4",
      "type": "docker",
      "hash": null,
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-03-18T22:52:48Z",
      "_links": {
        "self": {
          "href": "/v3/packages/guid-78c7ad0d-bb94-4e19-8442-6c71852ac1f4"
        },
        "app": {
          "href": "/v3/apps/guid-3edd2a0e-dcac-43f5-bd3b-a1536067e950"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c0a5ee03-eea0-421f-838a-16df9d3b22d5
Content-Length: 1346
X-Content-Type-Options: nosniff