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.eyJ1c2VyX2lkIjoidWFhLWlkLTM2OSIsImVtYWlsIjoiZW1haWwtMjY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDh9.WMQlN8mW00L3wpoSZb_D0mZpvh-DZgdBoxufVy_b3Kw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2OSIsImVtYWlsIjoiZW1haWwtMjY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDh9.WMQlN8mW00L3wpoSZb_D0mZpvh-DZgdBoxufVy_b3Kw" \
	-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-acfd75ff-d507-45c8-aa10-6b6b93fe449c",
      "type": "bits",
      "hash": {
        "type": "sha1",
        "value": null
      },
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-09-11T18:39:08Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/packages/guid-acfd75ff-d507-45c8-aa10-6b6b93fe449c"
        },
        "upload": {
          "href": "/v3/packages/guid-acfd75ff-d507-45c8-aa10-6b6b93fe449c/upload",
          "method": "POST"
        },
        "download": {
          "href": "/v3/packages/guid-acfd75ff-d507-45c8-aa10-6b6b93fe449c/download",
          "method": "GET"
        },
        "stage": {
          "href": "/v3/packages/guid-acfd75ff-d507-45c8-aa10-6b6b93fe449c/droplets",
          "method": "POST"
        },
        "app": {
          "href": "/v3/apps/guid-c1e1e77e-7d08-45a0-88bc-31bf14523653"
        }
      }
    },
    {
      "guid": "guid-329d222f-7b53-4db9-94f2-7944269137c9",
      "type": "docker",
      "hash": {
        "type": "sha1",
        "value": null
      },
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-09-11T18:39:08Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/packages/guid-329d222f-7b53-4db9-94f2-7944269137c9"
        },
        "app": {
          "href": "/v3/apps/guid-c1e1e77e-7d08-45a0-88bc-31bf14523653"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 28c5b1e4-5c01-4c52-89cf-a2cf766baf61
Content-Length: 1814
X-Content-Type-Options: nosniff