Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
workflowName
string

Workflow Name

stack
enum<string>

Stack

Available options:
node,
python,
go,
rust,
php,
ruby,
java,
dotnet
stackVersions
string

Versions

packageManager
enum<string>

Package Manager

Available options:
npm,
yarn,
pnpm
pythonManager
enum<string>

Package Manager

Available options:
pip,
poetry,
pipenv
javaDistribution
enum<string>

Java Distribution

Available options:
temurin,
zulu,
adopt,
microsoft,
corretto
javaBuild
enum<string>

Build Tool

Available options:
maven,
gradle
triggerPush
boolean

On push

pushBranches
string

Push branches

triggerPR
boolean

On pull_request

pRBranches
string

PR target branches

triggerSchedule
boolean

On schedule (cron)

cronExpression
string

Cron expression

triggerDispatch
boolean

On workflow_dispatch (manual)

matrixOS
string

Operating Systems

stepLint
boolean

Run lint step

lintCommand
string

Lint command

stepTest
boolean

Run test step

testCommand
string

Test command

stepBuild
boolean

Run build step

buildCommand
string

Build command

stepDeploy
boolean

Add a deploy job

deployBranch
string

Deploy from branch

deployCommand
string

Deploy command

enableCache
boolean

Cache dependencies

enableConcurrency
boolean

Cancel in-progress runs on the same ref

envVars
string

Environment Variables

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.