Skip to main content
POST
Create state

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Scopes

openid

OpenID Connect identity.

profile

Name and profile claims.

email

Email address.

offline_access

Refresh token.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

gitProvider
enum<string>
required

Where the repository this project lives in is hosted. Only github for now.

Available options:
github
gitOwner
string

Owner of the repository this project lives in.

Required string length: 1 - 255
gitRepo
string

Repository this project lives in.

Required string length: 1 - 255
directory
string

Project directory inside the repository, the one holding cargo.json. Defaults to the repository root.

Maximum string length: 1024
productionBranch
string

Pushes to this branch deploy once the repository is connected.

Required string length: 1 - 255
contents
Contents · object

Deploy state to start from, when moving a project off a committed state file.

Response

Create state

state
object
required
stateRun
State run · object

The deploy connecting started on the production branch, when a project created from a source auto-deploys.