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.eyJ1c2VyX2lkIjoidWFhLWlkLTkxIiwiZW1haWwiOiJlbWFpbC04M0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzU3fQ.r9hzHtxmDQGUA_3uRkME2u8vV_AnwQ5j9pTGaj6HdDE
Host: example.org
Cookie: 

Route

GET /v2/buildpacks

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f412cfe3-6215-41d3-82ab-54c516e9d3e7
Content-Length: 1311
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "bbe17bf4-8642-43e3-a6da-43aa5a86d520",
        "url": "/v2/buildpacks/bbe17bf4-8642-43e3-a6da-43aa5a86d520",
        "created_at": "2014-11-24T19:32:37+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name_1",
        "position": 1,
        "enabled": true,
        "locked": false,
        "filename": "name-474"
      }
    },
    {
      "metadata": {
        "guid": "3df83403-da06-488c-b681-8a02f483bcec",
        "url": "/v2/buildpacks/3df83403-da06-488c-b681-8a02f483bcec",
        "created_at": "2014-11-24T19:32:37+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name_2",
        "position": 2,
        "enabled": true,
        "locked": false,
        "filename": "name-475"
      }
    },
    {
      "metadata": {
        "guid": "d76c5aa5-b895-485a-8ff5-a299f033697a",
        "url": "/v2/buildpacks/d76c5aa5-b895-485a-8ff5-a299f033697a",
        "created_at": "2014-11-24T19:32:37+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name_3",
        "position": 3,
        "enabled": true,
        "locked": false,
        "filename": "name-476"
      }
    }
  ]
}