Home
Version 3
Buildpacks API

Buildpacks API

List all Buildpacks

GET /v2/buildpacks

Request

Route

GET /v2/buildpacks

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYiLCJlbWFpbCI6ImVtYWlsLTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzOTQyNjE5MX0.wf61D5NUZNHmzNP-dbhFknP0EuJCMWf08kxkWjXoOSs
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/buildpacks" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYiLCJlbWFpbCI6ImVtYWlsLTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzOTQyNjE5MX0.wf61D5NUZNHmzNP-dbhFknP0EuJCMWf08kxkWjXoOSs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "ee72e859-319e-4453-8b88-a3d7202e95fd",
        "url": "/v2/buildpacks/ee72e859-319e-4453-8b88-a3d7202e95fd",
        "created_at": "2015-08-06T00:36:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_1",
        "position": 1,
        "enabled": true,
        "locked": false,
        "filename": "name-13"
      }
    },
    {
      "metadata": {
        "guid": "f7148c2f-50d7-47c7-ad0d-ec1d738cd3e7",
        "url": "/v2/buildpacks/f7148c2f-50d7-47c7-ad0d-ec1d738cd3e7",
        "created_at": "2015-08-06T00:36:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_2",
        "position": 2,
        "enabled": true,
        "locked": false,
        "filename": "name-14"
      }
    },
    {
      "metadata": {
        "guid": "729c9590-7c71-42d7-a458-1eaa13030a46",
        "url": "/v2/buildpacks/729c9590-7c71-42d7-a458-1eaa13030a46",
        "created_at": "2015-08-06T00:36:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_3",
        "position": 3,
        "enabled": true,
        "locked": false,
        "filename": "name-15"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6ef53978-a54d-457b-bfe0-c7130abb67b8
Content-Length: 1293
X-Content-Type-Options: nosniff