Skip to main content
POST
Claim the next run of a schedule automation

Authorizations

X-Outerlayer-App-Id
string
header
required

Factory id the request is scoped to.

Authorization
string
header
required

API key (sk_outerlayer_*)

Headers

Signature
string

HTTP Message Signature (RFC 9421) made with the runner key's host key: runner=:<base64>:.

Signature-Input
string

The signature's covered components and parameters: runner=("@method" "@path" "@query" "content-digest");created=<unix seconds>;nonce="<random>";keyid="<host key fingerprint>";alg="ed25519".

Content-Digest
string

RFC 9530 digest of the request body, always sent, including for a request with none: sha-256=:<base64>:.

Body

application/json
host
string
required

The runner's host name.

Required string length: 1 - 255
isolation
enum<string>
required

What this runner's builds run in. A runner whose builds run with shared-user isolation is refused: a run needs a container or a microVM.

Available options:
container,
vm,
shared-user
cliVersion
string

The version of the CLI that makes the claim.

Required string length: 1 - 100
repos
object

The runner's repository include and exclude patterns, as in its configuration. * matches any text. The runner takes no run that reads a repository its patterns leave out.

runnerProtocol
integer

The runner protocol of the CLI. A runner below the run protocol is refused with 426.

seconds
integer

The lease length to ask for. The gateway clamps it to 30 to 900 seconds.

Required range: 0 < x <= 2147483647

Response

The run, or null when none is pending.

data
object | null
required

null when no run is pending.