Create a Package
POST /v3/apps/:guid/packages
Request
Route
POST /v3/apps/guid-d8b8148d-5798-44de-821a-64b85b15e968/packages
Body
| Name |
Description |
Default |
Valid Values |
Example Values |
|
type
|
Package type
|
|
|
|
|
data
|
Data for docker packages. Can be empty for bits packages.
|
|
|
|
|
data_image
|
Location of docker image. Required for docker packages.
|
|
|
|
|
data_credentials
|
Credentials for private docker image, available fields are user, password, email, login server.
|
|
|
|
|
data_store_image
|
Whether or not the backend should cache the image. defaults to false
|
|
|
|
{
"type": "docker",
"data": {
"image": "registry/image:latest",
"credentials": {
"user": "user name",
"password": "very secret password",
"email": "root@admin.example.com",
"login_server": "https://index.docker.io/v1"
},
"store_image": true
}
}
Headers
cURL
curl "https://api.[your-domain.com]/v3/apps/guid-d8b8148d-5798-44de-821a-64b85b15e968/packages" -d '{
"type": "docker",
"data": {
"image": "registry/image:latest",
"credentials": {
"user": "user name",
"password": "very secret password",
"email": "root@admin.example.com",
"login_server": "https://index.docker.io/v1"
},
"store_image": true
}
}' -X POST \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg0IiwiZW1haWwiOiJlbWFpbC04MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ3MTE2ODM0fQ.7UzyHZAHfEYinoQGxwjHkMpEjWVdvWSieBmktiWN_Gg" \
-H "Host: example.org" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "
Response
Status
201 Created
Body
{
"guid": "4cb65058-f04f-458f-aca1-5f4e43de6407",
"type": "docker",
"data": {
"hash": {
"type": "sha1",
"value": null
},
"error": null,
"image": "registry/image:latest",
"credentials": {
"user": "user name",
"email": "root@admin.example.com",
"password": "very secret password",
"login_server": "https://index.docker.io/v1"
},
"store_image": true
},
"state": "READY",
"created_at": "2015-11-03T00:53:54Z",
"updated_at": null,
"links": {
"self": {
"href": "/v3/packages/4cb65058-f04f-458f-aca1-5f4e43de6407"
},
"app": {
"href": "/v3/apps/guid-d8b8148d-5798-44de-821a-64b85b15e968"
}
}
}
Headers