| action | Convox command to run. One of: app-param, build, build-migrate, create, deploy, destroy, env-copy, env-set, find-build, find-release, get-scale, get-rack-param, login, login-user, promote, rack-param, rollback, run, scale | yes | — |
| password | Convox deploy key value | — | — |
| host | Convox Console host address | no | console.convox.com |
| token | Convox Console token value | — | — |
| rack | Convox Rack name | — | — |
| app | Convox app name | — | — |
| destinationApp | Convox destination app name for build migration | — | — |
| destinationRack | Convox destination rack name for build migration | — | — |
| description | Convox build description | — | — |
| cached | Whether to utilise the docker cache during the build | no | true |
| errorOnZeroScale | Whether to treat a scale of 0 as an error (useful for CI pipelines) | no | false |
| external | Build the image locally and push directly to the rack registry, bypassing the load balancer upload | no | false |
| buildArgs | (build) Docker build args in the form 'KEY1=VALUE1 KEY2=VALUE2', or newline-separated pairs. Each is passed to convox build as --build-args. | no | — |
| manifest | Use a custom path for your convox.yml | no | — |
| paramName | Name of the parameter to get or set | — | — |
| paramValue | Value of the parameter to set | — | — |
| release | ID of the release to promote. Only needed if you have not run a build step first or you wish to override the release id from the build | no | — |
| service | The service to run the command against | — | — |
| command | The command to be run | — | — |
| count | The number of instances to scale to | — | — |
| env | Environment variables in the form 'key1=value1 key2=value2', or newline-separated pairs when values contain spaces | — | — |
| exclude | (env-copy) Space- or newline-separated list of env var names to omit when copying from the source app | no | — |
| params | (app-param) App parameters to set in the form 'Key1=value1 Key2=value2', or newline-separated pairs when values contain spaces | — | — |