Home
Version 3
Packages (Experimental) API

Packages (Experimental) API

Stage a package

POST /v3/packages/:guid/droplets

Request

Route

POST /v3/packages/guid-eb8e7cd1-2af0-4a3a-b167-8267a39c6c6a/droplets

Body

Name Description Default Valid Values Example Values
environment_variables Environment variables to use during staging. Environment variable names may not start with "VCAP_" or "CF_". "PORT" is not a valid environment variable.
  • {"FEATURE_ENABLED": "true"}
memory_limit Memory limit used to stage package
disk_limit Disk limit used to stage package
lifecycle Lifecycle information for a droplet. If not provided, it will default to a buildpack
  • {:lifecycle=>{:type=>"buildpack", :data=>{:buildpack=>"http://github.com/myorg/awesome-buildpack", :stack=>"cflinuxfs2"}}}
{
  "environment_variables": {
    "CUSTOM_ENV_VAR": "hello"
  },
  "lifecycle": {
    "type": "buildpack",
    "data": {
      "buildpack": "http://github.com/myorg/awesome-buildpack",
      "stack": "cflinuxfs2"
    }
  }
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NSIsImVtYWlsIjoiZW1haWwtMTk4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NTh9.U65n_KbcBWofyYLb5yQHkFs5KJU7CBnVz1HHLzJ1Gpw
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/packages/guid-eb8e7cd1-2af0-4a3a-b167-8267a39c6c6a/droplets" -d '{
  "environment_variables": {
    "CUSTOM_ENV_VAR": "hello"
  },
  "lifecycle": {
    "type": "buildpack",
    "data": {
      "buildpack": "http://github.com/myorg/awesome-buildpack",
      "stack": "cflinuxfs2"
    }
  }
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NSIsImVtYWlsIjoiZW1haWwtMTk4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NTh9.U65n_KbcBWofyYLb5yQHkFs5KJU7CBnVz1HHLzJ1Gpw" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "guid": "whatuuid",
  "state": "PENDING",
  "error": null,
  "lifecycle": {
    "type": "buildpack",
    "data": {
      "buildpack": "http://github.com/myorg/awesome-buildpack",
      "stack": "cflinuxfs2"
    }
  },
  "memory_limit": 1024,
  "disk_limit": 4096,
  "result": {
    "buildpack": "http://github.com/myorg/awesome-buildpack",
    "stack": "cflinuxfs2",
    "process_types": null,
    "hash": {
      "type": "sha1",
      "value": null
    },
    "execution_metadata": null
  },
  "environment_variables": {
    "CUSTOM_ENV_VAR": "hello",
    "VCAP_APPLICATION": {
      "limits": {
        "mem": 1024,
        "disk": 4096,
        "fds": 16384
      },
      "application_id": "guid-e7743d3e-80cf-4e0e-8c2d-904d6b78872b",
      "application_version": "whatuuid",
      "application_name": "name-2035",
      "application_uris": [

      ],
      "version": "whatuuid",
      "name": "name-2035",
      "space_name": "name-2032",
      "space_id": "db19bb99-7dc1-423e-a3f0-e71c21ce5cef",
      "uris": [

      ],
      "users": null
    },
    "CF_STACK": "cflinuxfs2",
    "MEMORY_LIMIT": 1024,
    "VCAP_SERVICES": {

    }
  },
  "created_at": "2015-10-15T23:52:38Z",
  "updated_at": null,
  "links": {
    "self": {
      "href": "/v3/droplets/whatuuid"
    },
    "package": {
      "href": "/v3/packages/guid-eb8e7cd1-2af0-4a3a-b167-8267a39c6c6a"
    },
    "app": {
      "href": "/v3/apps/guid-e7743d3e-80cf-4e0e-8c2d-904d6b78872b"
    },
    "assign_current_droplet": {
      "href": "/v3/apps/guid-e7743d3e-80cf-4e0e-8c2d-904d6b78872b/current_droplet",
      "method": "PUT"
    }
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: whatuuid
Content-Length: 1617
X-Content-Type-Options: nosniff