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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MCIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTZ9.UkwQD3B9UX7zkZqnPcOmByENRjq9VXhWgBIuEJ0KkLw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/buildpacks" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MCIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTZ9.UkwQD3B9UX7zkZqnPcOmByENRjq9VXhWgBIuEJ0KkLw" \
	-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": "997f4430-9128-4e07-99b8-f7dd2f363b30",
        "url": "/v2/buildpacks/997f4430-9128-4e07-99b8-f7dd2f363b30",
        "created_at": "2015-05-21T01:03:16Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_1",
        "position": 1,
        "enabled": true,
        "locked": false,
        "filename": "name-1985"
      }
    },
    {
      "metadata": {
        "guid": "7b43b6d6-e9de-4898-bdec-efc6ed54ce5f",
        "url": "/v2/buildpacks/7b43b6d6-e9de-4898-bdec-efc6ed54ce5f",
        "created_at": "2015-05-21T01:03:16Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_2",
        "position": 2,
        "enabled": true,
        "locked": false,
        "filename": "name-1986"
      }
    },
    {
      "metadata": {
        "guid": "68dc5ef1-70b0-4921-893d-da2c386fd4c9",
        "url": "/v2/buildpacks/68dc5ef1-70b0-4921-893d-da2c386fd4c9",
        "created_at": "2015-05-21T01:03:16Z",
        "updated_at": null
      },
      "entity": {
        "name": "name_3",
        "position": 3,
        "enabled": true,
        "locked": false,
        "filename": "name-1987"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: fe04d257-5147-4bca-b1d5-9a122786492e
Content-Length: 1299
X-Content-Type-Options: nosniff