Actions and Details

A full list of all pipeline actions and the details that accompany each action. Examples for each action can be found in the examples area.

sleep
  • sleep
    object

    An action that causes the pipeline to wait a certain duration of time.

    Show child fields
webhook.post
  • webhook.post
    object

    A webhook that posts to a url with information from a step.

    Show child fields
container.create
  • container.create
    object

    Details for the container create action.

    Show child fields
container.reimage
  • container.reimage
    object

    Details for the container reimage action.

    Show child fields
container.restart
  • container.restart
    object

    Details for the container restart action.

    Show child fields
container.start
  • container.start
    object

    Details for the container start action.

    Show child fields
container.stop
  • container.stop
    object

    Details for the container stop action.

    Show child fields
container.delete
  • container.delete
    object

    Details for the container delete action.

    Show child fields
image.create.source
  • image.source.create
    object

    Details for the image create source action.

    Show child fields
image.create
  • image.create
    object

    Details for the image create action.

    Show child fields
image.import
  • image.import
    object

    Details for the image import action.

    Show child fields
images.prune
  • images.prune
    object

    Either an empty array, which will remove all unused images from the hub or an array of source ids which will remove all unused images for each source listed.

    Show child fields
environment.create
  • environment.create
    object

    An object holding the necessary information to use the environment create action.

    Show child fields
environment.delete
  • environment.delete
    object

    Details for the environment delete action.

    Show child fields
environment.start
  • environment.start
    object

    Details for the environment start action.

    Show child fields
environment.stop
  • environment.stop
    object

    Details for the environment stop action.

    Show child fields
stack.build.create
  • stack.build.create
    object

    An object holding the necessary information to create a stack build.

    Show child fields
stack.build.generate
  • stack.build.generate
    object

    Details for the stack build generate action.

    Show child fields
sleep
{
"seconds": 30
}
webhook.post
{
"url": "https://demo.url.endpoint",
"from": {
"stage": "demo stage name",
"step": "demo step name"
}
}
container.create
{
"name": "demoname",
"environment": {
"from": {
"stage": "demo stage name",
"step": "demo step name"
}
},
"image": {
"id": "5b9c2a77b6393d0001eb45fd"
},
"stateful": false,
"annotations": {},
"config": {
"network": {
"public": "enable",
"hostname": "website",
"ports": [
"80:80"
]
},
"deploy": {
"instances": 1
}
}
}
container [start, stop, restart, delete] with ID
{
"id": "5b9c2a77b6393d0001eb45fd"
}
container [start, stop, restart, delete] from previous step | stage
{
"from": {
"stage": "demo stage name",
"step": "demo step name"
}
}
container.reimage
{
"from": {
"stage": "demo stage name",
"step": "demo step name"
},
"image": {
"id": "5fff2a77b6393d0001eb3333"
}
}
create.image.source
{
"name": "Demo Name",
"about": {
"description": "Some information about this source."
},
"type": "direct",
"origin": {
"type": "docker-hub",
"details": {
"target": "alpine:latest",
"username": "demouser",
"token": "3b3b027f-cf8b-4732-86d2-8e885a7d16f2"
}
}
}
create.image
{
"name": "Demo Name",
"source": {
"id": "5b9c2a77b6393d0001eb45fd"
}
}
image [import] with ID
{
"id": "5b9c2a77b6393d0001eb45fd"
}
image [import] from previous step | stage
{
"from": {
"stage": "demo stage name",
"step": "demo step name"
}
}
images.prune
{
"source_ids": []
}
stack.build.create
{
"stack": {
"id": "5b9c2a77b6393d0001eb45fd"
},
"type": "direct",
"instructions": {
"git": {
"type": "tag",
"value": "v2021.02.28.01"
}
},
"about": {
"version": "1",
"description": "Some info about the stack build"
}
}
stack.build.generate
{
"id": {
"id": "5b9c2a77b6393d0001eb45fd"
},
"form": {
"from": {
"stage": "demo stage name",
"step": "demo step name"
}
}
}