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.eyJ1c2VyX2lkIjoidWFhLWlkLTQyOCIsImVtYWlsIjoiZW1haWwtMjk2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5NDZ9.XE39V5RjrORJ_yOz7ZdHlYZLcEvmZzbjVxhfBHSkCEU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyOCIsImVtYWlsIjoiZW1haWwtMjk2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5NDZ9.XE39V5RjrORJ_yOz7ZdHlYZLcEvmZzbjVxhfBHSkCEU" \
	-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-d5cfeb06-ed19-4ba5-8a68-df29bbc2dacf",
      "type": "bits",
      "hash": {
        "type": "sha1",
        "value": null
      },
      "url": null,
      "state": "AWAITING_UPLOAD",
      "error": null,
      "created_at": "2015-10-07T00:35:46Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/packages/guid-d5cfeb06-ed19-4ba5-8a68-df29bbc2dacf"
        },
        "upload": {
          "href": "/v3/packages/guid-d5cfeb06-ed19-4ba5-8a68-df29bbc2dacf/upload",
          "method": "POST"
        },
        "download": {
          "href": "/v3/packages/guid-d5cfeb06-ed19-4ba5-8a68-df29bbc2dacf/download",
          "method": "GET"
        },
        "stage": {
          "href": "/v3/packages/guid-d5cfeb06-ed19-4ba5-8a68-df29bbc2dacf/droplets",
          "method": "POST"
        },
        "app": {
          "href": "/v3/apps/guid-4c867449-a9a7-4a44-9b38-2e71464c8c62"
        }
      }
    },
    {
      "guid": "guid-20a5b6ad-36f1-40fc-9817-18da69cfd160",
      "type": "docker",
      "hash": {
        "type": "sha1",
        "value": null
      },
      "url": "http://docker-repo/my-image",
      "state": "READY",
      "error": null,
      "created_at": "2015-10-07T00:35:46Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/packages/guid-20a5b6ad-36f1-40fc-9817-18da69cfd160"
        },
        "app": {
          "href": "/v3/apps/guid-4c867449-a9a7-4a44-9b38-2e71464c8c62"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a94da465-d1b5-41f2-95a0-c3b6a8efc30e
Content-Length: 1812
X-Content-Type-Options: nosniff