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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMyIsImVtYWlsIjoiZW1haWwtMTY1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NTZ9.dJd-cJiD6SF_D7sWNN05IubOHWJF7zs7gBDz63H_BKo
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/buildpacks" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMyIsImVtYWlsIjoiZW1haWwtMTY1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NTZ9.dJd-cJiD6SF_D7sWNN05IubOHWJF7zs7gBDz63H_BKo" \
	-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": "883d0c9a-10cd-46df-9883-9f64ccfe80ec",
        "url": "/v2/buildpacks/883d0c9a-10cd-46df-9883-9f64ccfe80ec",
        "created_at": "2015-03-20T18:27:36Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_1",
        "position": 1,
        "enabled": true,
        "locked": false,
        "filename": "name-1368"
      }
    },
    {
      "metadata": {
        "guid": "1e08c210-e102-49da-b5f1-a872aca56fac",
        "url": "/v2/buildpacks/1e08c210-e102-49da-b5f1-a872aca56fac",
        "created_at": "2015-03-20T18:27:36Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_2",
        "position": 2,
        "enabled": true,
        "locked": false,
        "filename": "name-1369"
      }
    },
    {
      "metadata": {
        "guid": "f19acda3-3174-4657-87b8-ec55765ef734",
        "url": "/v2/buildpacks/f19acda3-3174-4657-87b8-ec55765ef734",
        "created_at": "2015-03-20T18:27:36Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_3",
        "position": 3,
        "enabled": true,
        "locked": false,
        "filename": "name-1370"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 37746c53-46a7-4d08-ad50-5397dce4997a
Content-Length: 1299
X-Content-Type-Options: nosniff