Get apiv1deployments

cURL

curl --request GET \
  --url https://api.staging.qyl.dev/api/v1/deployments

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.qyl.dev/api/v1/deployments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.qyl.dev/api/v1/deployments"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/deployments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "deployment.id": "<string>",
      "service.name": "<string>",
      "service.version": "2.1.0",
      "environment": "development",
      "status": "pending",
      "strategy": "rolling",
      "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>"
}

{
  "type": "about:blank",
  "title": "Validation Failed",
  "status": 123,
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>",
      "rejected_value": "<string>"
    }
  ],
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "error_code": "<string>"
}

GET

api

deployments

cURL

curl --request GET \
  --url https://api.staging.qyl.dev/api/v1/deployments

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.qyl.dev/api/v1/deployments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.qyl.dev/api/v1/deployments"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/deployments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "deployment.id": "<string>",
      "service.name": "<string>",
      "service.version": "2.1.0",
      "environment": "development",
      "status": "pending",
      "strategy": "rolling",
      "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>"
}

{
  "type": "about:blank",
  "title": "Validation Failed",
  "status": 123,
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>",
      "rejected_value": "<string>"
    }
  ],
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "error_code": "<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

Show child attributes

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)

Getting Started

Features

API Reference

Alerts

Configurator

Deployments

Errors

Issues

Logs

Metrics

Onboarding

Search

Services

Sessions

Streaming

Traces

Workflows

Workspaces

Health

Query Parameters

Response