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.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NSIsImVtYWlsIjoiZW1haWwtMTcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NDd9.AuxUN3lx6vmN10zakJs5793YzDYcI27WaaYf6dxij9c
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NSIsImVtYWlsIjoiZW1haWwtMTcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NDd9.AuxUN3lx6vmN10zakJs5793YzDYcI27WaaYf6dxij9c" \
	-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-893a6643-6596-41c6-8655-70fd90d80d43",
      "type": "bits",
      "hash": {
        "type": "sha1",
        "value": null
      },
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-09-30T23:30:47Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/packages/guid-893a6643-6596-41c6-8655-70fd90d80d43"
        },
        "upload": {
          "href": "/v3/packages/guid-893a6643-6596-41c6-8655-70fd90d80d43/upload",
          "method": "POST"
        },
        "download": {
          "href": "/v3/packages/guid-893a6643-6596-41c6-8655-70fd90d80d43/download",
          "method": "GET"
        },
        "stage": {
          "href": "/v3/packages/guid-893a6643-6596-41c6-8655-70fd90d80d43/droplets",
          "method": "POST"
        },
        "app": {
          "href": "/v3/apps/guid-b1f9be1d-76fd-4820-a741-5f549a44ed66"
        }
      }
    },
    {
      "guid": "guid-1dd1d7ef-34f7-4fd4-b4b7-06c50839c851",
      "type": "docker",
      "hash": {
        "type": "sha1",
        "value": null
      },
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-09-30T23:30:47Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/packages/guid-1dd1d7ef-34f7-4fd4-b4b7-06c50839c851"
        },
        "app": {
          "href": "/v3/apps/guid-b1f9be1d-76fd-4820-a741-5f549a44ed66"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0f134f85-1ea6-42c9-8310-83f1b7c81f5d
Content-Length: 1812
X-Content-Type-Options: nosniff