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.eyJ1c2VyX2lkIjoidWFhLWlkLTIyMSIsImVtYWlsIjoiZW1haWwtMTQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDF9.5TAbTxgGxnynKKOKbxo-k_-ksNhx1prhWJvaTbb5Xs8
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyMSIsImVtYWlsIjoiZW1haWwtMTQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDF9.5TAbTxgGxnynKKOKbxo-k_-ksNhx1prhWJvaTbb5Xs8" \
	-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-7a1c72cb-0492-476e-9f93-f5981485da5b",
      "type": "bits",
      "hash": null,
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-04-15T00:55:41Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/packages/guid-7a1c72cb-0492-476e-9f93-f5981485da5b"
        },
        "upload": {
          "href": "/v3/packages/guid-7a1c72cb-0492-476e-9f93-f5981485da5b/upload",
          "method": "POST"
        },
        "app": {
          "href": "/v3/apps/guid-57f8e375-49ee-4a5f-8700-df2651a94bc6"
        }
      }
    },
    {
      "guid": "guid-d191d63a-587b-4e84-a291-33e11713706b",
      "type": "docker",
      "hash": null,
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-04-15T00:55:41Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/packages/guid-d191d63a-587b-4e84-a291-33e11713706b"
        },
        "app": {
          "href": "/v3/apps/guid-57f8e375-49ee-4a5f-8700-df2651a94bc6"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a4efe5cb-a737-4dc6-ae23-5bb7eb7fd541
Content-Length: 1426
X-Content-Type-Options: nosniff