Skip to content
Nexa Platform Docs

Get Deployment Status

GET
/api/v1/deployments/{deployment_id}/status
curl --request GET \
  --url https://example.com/api/v1/deployments/example/status

Get complete deployment status including all file details.

Returns: Deployment record, file details, and statistics

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
deployment_id
required
Deployment Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
DeploymentStatusResponse

Complete deployment status.

object
deployment
required
DeploymentResponse

Deployment response.

object
id
required
Id
string
deployment_name
Any of:
string
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
created_at
required
Created At
string
started_at
required
Any of:
string
completed_at
required
Any of:
string
initiated_by
Any of:
string
error_message
Any of:
string
details
required
Details
Array<object>
DeploymentDetailResponse

Deployment detail response.

object
id
required
Id
string
file_path
required
File Path
string
file_type
required
File Type
string
git_status
required
Git Status
string
deployment_status
required
Deployment Status
string
error_message
required
Any of:
string
deployed_at
required
Any of:
string
stats
required
Stats
object
key
additional properties
any
Examplegenerated
{
  "deployment": {
    "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"
  },
  "details": [
    {
      "id": "example",
      "file_path": "example",
      "file_type": "example",
      "git_status": "example",
      "deployment_status": "example",
      "error_message": "example",
      "deployed_at": "example"
    }
  ],
  "stats": {}
}

422

Section titled “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
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}