Home
Version 3
Buildpacks API

Buildpacks API

Enable or disable a Buildpack

PUT /v2/buildpacks/:guid

Request

Route

PUT /v2/buildpacks/ffeb6866-8c45-478f-ae86-87ee43aa90d3

Parameters

Name Description Valid Values Example Values
guid The guid of the Buildpack

Body

Name Description Default Valid Values Example Values
name The name of the buildpack. To be used by app buildpack field. (only alphanumeric characters)
  • Golang_buildpack
position The order in which the buildpacks are checked during buildpack auto-detection.
enabled Whether or not the buildpack will be used for staging true
locked Whether or not the buildpack is locked to prevent updates false
filename The name of the uploaded buildpack file 
{
  "enabled": false
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NCIsImVtYWlsIjoiZW1haWwtMjY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Nzh9.a5c1lZDxh-xapDYbOVPNAXSulWMgt2X29TVC0Srn_A8
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/buildpacks/ffeb6866-8c45-478f-ae86-87ee43aa90d3" -d '{
  "enabled": false
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NCIsImVtYWlsIjoiZW1haWwtMjY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Nzh9.a5c1lZDxh-xapDYbOVPNAXSulWMgt2X29TVC0Srn_A8" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "ffeb6866-8c45-478f-ae86-87ee43aa90d3",
    "url": "/v2/buildpacks/ffeb6866-8c45-478f-ae86-87ee43aa90d3",
    "created_at": "2015-03-03T00:51:18Z",
    "updated_at": "2015-03-03T00:51:18Z"
  },
  "entity": {
    "name": "name_1",
    "position": 1,
    "enabled": false,
    "locked": false,
    "filename": "name-1999"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: eb904a09-fe63-4666-be07-4aa4de0ec844
Content-Length: 355
X-Content-Type-Options: nosniff

Request

Route

PUT /v2/buildpacks/ffeb6866-8c45-478f-ae86-87ee43aa90d3

Parameters

Name Description Valid Values Example Values
guid The guid of the Buildpack

Body

Name Description Default Valid Values Example Values
name The name of the buildpack. To be used by app buildpack field. (only alphanumeric characters)
  • Golang_buildpack
position The order in which the buildpacks are checked during buildpack auto-detection.
enabled Whether or not the buildpack will be used for staging true
locked Whether or not the buildpack is locked to prevent updates false
filename The name of the uploaded buildpack file 
{
  "enabled": true
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NCIsImVtYWlsIjoiZW1haWwtMjY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Nzh9.a5c1lZDxh-xapDYbOVPNAXSulWMgt2X29TVC0Srn_A8
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/buildpacks/ffeb6866-8c45-478f-ae86-87ee43aa90d3" -d '{
  "enabled": true
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NCIsImVtYWlsIjoiZW1haWwtMjY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Nzh9.a5c1lZDxh-xapDYbOVPNAXSulWMgt2X29TVC0Srn_A8" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "ffeb6866-8c45-478f-ae86-87ee43aa90d3",
    "url": "/v2/buildpacks/ffeb6866-8c45-478f-ae86-87ee43aa90d3",
    "created_at": "2015-03-03T00:51:18Z",
    "updated_at": "2015-03-03T00:51:18Z"
  },
  "entity": {
    "name": "name_1",
    "position": 1,
    "enabled": true,
    "locked": false,
    "filename": "name-1999"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 61e340d7-bc00-416d-b508-286fe5beb774
Content-Length: 354
X-Content-Type-Options: nosniff