Packages (Experimental) API

Create a Package

POST /v3/apps/:guid/packages

Request

Route

POST /v3/apps/guid-18ec33fc-a190-42fd-ab0b-67679605aa7f/packages

Body

Name	Description	Parameter Type	Valid Values	Example Values
type	Package type	String	bits docker
data	Data for docker packages. Can be empty for bits packages.
data["image"]	Location of docker image. Required for docker packages.	String		registry/image:latest

{
  "type": "docker",
  "data": {
    "image": "registry/image:latest"
  }
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyIiwiZW1haWwiOiJlbWFpbC0zMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU4NTk5NDIzfQ.Oh0RtNbVCg3DpmQ7KN_llOAKA8DAETNYzidm8zjeqlc
Content-Type: application/json
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-18ec33fc-a190-42fd-ab0b-67679605aa7f/packages" -d '{
  "type": "docker",
  "data": {
    "image": "registry/image:latest"
  }
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyIiwiZW1haWwiOiJlbWFpbC0zMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU4NTk5NDIzfQ.Oh0RtNbVCg3DpmQ7KN_llOAKA8DAETNYzidm8zjeqlc" \
	-H "Content-Type: application/json" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "guid": "e316b58a-d91f-4e42-995f-b1234fe39f32",
  "type": "docker",
  "data": {
    "image": "registry/image:latest"
  },
  "state": "READY",
  "created_at": "2016-03-14T22:30:23Z",
  "updated_at": null,
  "links": {
    "self": {
      "href": "/v3/packages/e316b58a-d91f-4e42-995f-b1234fe39f32"
    },
    "stage": {
      "href": "/v3/packages/e316b58a-d91f-4e42-995f-b1234fe39f32/droplets",
      "method": "POST"
    },
    "app": {
      "href": "/v3/apps/guid-18ec33fc-a190-42fd-ab0b-67679605aa7f"
    }
  }
}

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
X-Runtime: 0.028102
Content-Length: 520