Skip to main content
GET
/
api
/
v1
/
deployments
cURL
curl --request GET \
  --url https://api.staging.qyl.dev/api/v1/deployments
{
  "items": [
    {
      "deployment.id": "<string>",
      "service.name": "<string>",
      "service.version": "2.1.0",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "duration_s": 1,
      "deployed_by": "<string>",
      "git_commit": "<string>",
      "git_branch": "<string>",
      "previous_version": "2.1.0",
      "rollback_target": "<string>",
      "replica_count": 123,
      "healthy_replicas": 123,
      "error_message": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>",
  "prev_cursor": "<string>"
}

Query Parameters

​
serviceName
string

Service name filter

​
environment
enum<string>

Environment filter Deployment environments

Available options:
development,
testing,
staging,
production,
preview,
canary
​
status
enum<string>

Status filter Deployment status

Available options:
pending,
in_progress,
success,
failed,
rolled_back,
cancelled
​
startTime
string<date-time>

Start time

​
endTime
string<date-time>

End time

​
limit
integer<int32>
default:100

Page size

Required range: 1 <= x <= 1000
​
cursor
string

Cursor

Response

The request has succeeded.

Cursor-based paginated response wrapper

​
items
object[]
required

List of items in this page

​
has_more
boolean
required

Whether there are more items available

​
next_cursor
string

Cursor for the next page (null if no more pages)

​
prev_cursor
string

Cursor for the previous page (null if first page)