Home
Version 3
Buildpacks API

Buildpacks API

List all Buildpacks

GET /v2/buildpacks

Fields

Name Description Default Valid Values Example Values

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMiIsImVtYWlsIjoiZW1haWwtOTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDMxMDEyNX0.7LbZd3Q4gmAmG7uDRehgZ1-9peNZPYa5LeTzaG0tX64
Host: example.org
Cookie: 

Route

GET /v2/buildpacks

cURL

curl "https://api.[your-domain.com]/v2/buildpacks" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMiIsImVtYWlsIjoiZW1haWwtOTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDMxMDEyNX0.7LbZd3Q4gmAmG7uDRehgZ1-9peNZPYa5LeTzaG0tX64" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ab011364-3bf5-44fb-8acb-4900225db938
Content-Length: 1296
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "23f1fa3f-8562-4d5f-9df9-9aa62bbcd8e6",
        "url": "/v2/buildpacks/23f1fa3f-8562-4d5f-9df9-9aa62bbcd8e6",
        "created_at": "2015-02-12T01:42:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_1",
        "position": 1,
        "enabled": true,
        "locked": false,
        "filename": "name-408"
      }
    },
    {
      "metadata": {
        "guid": "a57f53b1-814f-4dc7-bda1-a82f947a8703",
        "url": "/v2/buildpacks/a57f53b1-814f-4dc7-bda1-a82f947a8703",
        "created_at": "2015-02-12T01:42:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_2",
        "position": 2,
        "enabled": true,
        "locked": false,
        "filename": "name-409"
      }
    },
    {
      "metadata": {
        "guid": "44db020b-18a8-4719-a514-0db8539ffdbd",
        "url": "/v2/buildpacks/44db020b-18a8-4719-a514-0db8539ffdbd",
        "created_at": "2015-02-12T01:42:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_3",
        "position": 3,
        "enabled": true,
        "locked": false,
        "filename": "name-410"
      }
    }
  ]
}