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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQwMSIsImVtYWlsIjoiZW1haWwtMjkzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk4MDB9.usFM7pqqihKWsqawKJBHu1z-In0NxY2nYKO3_XwWCD8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQwMSIsImVtYWlsIjoiZW1haWwtMjkzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk4MDB9.usFM7pqqihKWsqawKJBHu1z-In0NxY2nYKO3_XwWCD8" \
	-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-81909c25-d2b6-40c6-9800-2efcc9a79d20",
      "type": "bits",
      "hash": null,
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-07-06T23:23:20Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/packages/guid-81909c25-d2b6-40c6-9800-2efcc9a79d20"
        },
        "upload": {
          "href": "/v3/packages/guid-81909c25-d2b6-40c6-9800-2efcc9a79d20/upload",
          "method": "POST"
        },
        "stage": {
          "href": "/v3/packages/guid-81909c25-d2b6-40c6-9800-2efcc9a79d20/droplets",
          "method": "POST"
        },
        "app": {
          "href": "/v3/apps/guid-5289a244-b1aa-49c1-a1cc-4c6a256f31ef"
        }
      }
    },
    {
      "guid": "guid-549f81f4-f7fd-4f0f-9c8b-ec97c1edc1e6",
      "type": "docker",
      "hash": null,
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-07-06T23:23:20Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/packages/guid-549f81f4-f7fd-4f0f-9c8b-ec97c1edc1e6"
        },
        "app": {
          "href": "/v3/apps/guid-5289a244-b1aa-49c1-a1cc-4c6a256f31ef"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 95cc8045-8ab0-4ed3-9bba-01447941600e
Content-Length: 1568
X-Content-Type-Options: nosniff