Deployments

Create, finalize, and resolve deployments to publish and serve project artifacts.

Create a deployment

post

Create a deployment and receive signed upload URLs for the files Argos doesn't already store. Files already present (matched by content hash) are reused and omitted from uploadFiles. The environment is inferred from the branch when omitted.

Authorizations

projectToken

AuthorizationstringRequired

Authenticate as a project with a project token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <project-token>

You can find your project token in your Argos project settings. Project tokens are used by CI and the SDK to create builds and deployments.

Body

application/json

commitstringRequired

The commit SHA

Pattern: ^[0-9a-f]{40}$

branchstring · min: 1Required

The branch name

prNumberinteger · min: 1 · max: 9007199254740991 · nullableOptional

The pull request number

environmentstring · enumOptional

The deployment environment. When omitted, it is inferred from branch: branches matching the configured production-branch glob are treated as production; all others default to preview.

Possible values:

Responses

201

Deployment created

application/json

deploymentIdstringRequired

400

Invalid parameters

application/json

401

Unauthorized

application/json

500

Server error

application/json

post/deployments

HTTPcURLJavaScriptPython

POST /v2/deployments HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "commit": "text",
  "branch": "text",
  "prNumber": 1,
  "environment": "preview",
  "files": [
    {
      "path": "text",
      "hash": "text",
      "size": 1,
      "contentType": "text"
    }
  ]
}

{
  "deploymentId": "text",
  "uploadFiles": [
    {
      "path": "text",
      "hash": "text",
      "uploadUrl": "https://example.com"
    }
  ]
}

Get a deployment

get

Retrieve a single deployment by its ID.

Authorizations

projectToken

AuthorizationstringRequired

Authenticate as a project with a project token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <project-token>

You can find your project token in your Argos project settings. Project tokens are used by CI and the SDK to create builds and deployments.

Path parameters

deploymentIdstringRequired

The deployment ID

Responses

200

Deployment details

application/json

idstringRequired

statusstring · enumRequiredPossible values:

environmentstring · enumRequiredPossible values:

branchstring · min: 1Required

commitShastringRequired

SHA256 hash

Pattern: ^[A-Fa-f0-9]{64}$

urlstring · uriRequired

createdAtstringRequired

400

Invalid parameters

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Server error

application/json

get/deployments/{deploymentId}

HTTPcURLJavaScriptPython

GET /v2/deployments/{deploymentId} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "status": "pending",
  "environment": "preview",
  "branch": "text",
  "commitSha": "text",
  "url": "https://example.com",
  "createdAt": "text"
}

Finalize a deployment

post

Mark a deployment as ready once all of its files have been uploaded. Argos assigns the deployment's aliases and starts serving it.

Authorizations

projectToken

AuthorizationstringRequired

Authenticate as a project with a project token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <project-token>

You can find your project token in your Argos project settings. Project tokens are used by CI and the SDK to create builds and deployments.

Path parameters

deploymentIdstringRequired

The deployment ID

Responses

200

Deployment finalized

application/json

idstringRequired

statusstring · enumRequiredPossible values:

environmentstring · enumRequiredPossible values:

branchstring · min: 1Required

commitShastringRequired

SHA256 hash

Pattern: ^[A-Fa-f0-9]{64}$

urlstring · uriRequired

createdAtstringRequired

400

Invalid parameters

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Server error

application/json

post/deployments/{deploymentId}/finalize

HTTPcURLJavaScriptPython

POST /v2/deployments/{deploymentId}/finalize HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "status": "pending",
  "environment": "preview",
  "branch": "text",
  "commitSha": "text",
  "url": "https://example.com",
  "createdAt": "text"
}

Resolve a deployment domain

get

Resolve a deployment domain or URL to the deployment it currently serves. This endpoint is public and does not require authentication.

Path parameters

domainstringRequired

A deployment domain or URL

Responses

200

Deployment domain resolved

application/json

deploymentIdstringRequired

projectIdstringRequired

environmentstring · enumRequiredPossible values:

visibilitystring · enumRequiredPossible values:

400

Invalid parameters

application/json

404

Not found

application/json

500

Server error

application/json

get/deployments/resolve/{domain}

HTTPcURLJavaScriptPython

GET /v2/deployments/resolve/{domain} HTTP/1.1
Host: api.argos-ci.com
Accept: */*

{
  "deploymentId": "text",
  "projectId": "text",
  "environment": "preview",
  "visibility": "private"
}