Submit Deployment

POST

/api/v1/deployments/submit

curl --request POST \
  --url https://example.com/api/v1/deployments/submit \
  --header 'Content-Type: application/json' \
  --data '{ "environment_id": "example", "git_branch": "example", "git_commit_sha": "example", "status": "example", "stage_name": "example", "deployment_log": "example", "job_run_url": "example", "deployed_files": [ { "file_path": "example", "file_type": "other", "status": "modified", "platform_object_id": "example", "deployment_status": "example", "error_message": "example" } ], "deployment_name": "example", "deployment_id": "example" }'

Submit results from an external deployment stage.

Request Body^required

Media typeapplication/json

DeploymentSubmitRequest

Request to submit a deployment executed externally (e.g. via DABs).

object

environment_id

Any of:

string

string

null

null

git_branch

Any of:

string

string

null

null

git_commit_sha

Any of:

string

string

null

null

status

required

Status

string

stage_name

required

Stage Name

string

deployment_log

Any of:

string

string

null

null

job_run_url

Any of:

string

string

null

null

deployed_files

Any of:

Array<object>

Array<object>

DeploymentFileSubmit

Record of a single file in a deployment.

object

file_path

required

File Path

string

file_type

File Type

string

default: other

status

Status

string

default: modified

platform_object_id

Any of:

string

string

null

null

deployment_status

Any of:

string

string

null

null

error_message

Any of:

string

string

null

null

null

null

deployment_name

Any of:

string

string

null

null

deployment_id

required

Deployment Id

The ID returned by /start to correlate this record

string

Responses

200

Successful Response

Media typeapplication/json

DeploymentResponse

Deployment response.

object

id

required

Id

string

deployment_name

Any of:

string

string

null

null

environment_id

required

Environment Id

string

git_branch

required

Git Branch

string

git_commit_sha

required

Git Commit Sha

string

status

required

Status

string

job_run_id

required

Any of:

string

string

null

null

created_at

required

Created At

string

started_at

required

Any of:

string

string

null

null

completed_at

required

Any of:

string

string

null

null

initiated_by

Any of:

string

string

null

null

error_message

Any of:

string

string

null

null

Example^generated

{
  "id": "example",
  "deployment_name": "example",
  "environment_id": "example",
  "git_branch": "example",
  "git_commit_sha": "example",
  "status": "example",
  "job_run_id": "example",
  "created_at": "example",
  "started_at": "example",
  "completed_at": "example",
  "initiated_by": "example",
  "error_message": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}