Get environment statuses with stages

GET /environment/{environmentId}/statusesWithStages

Get environment statuses with stages

cURL

curl --request GET \
  --url https://api.qovery.com/environment/{environmentId}/statusesWithStages \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.qovery.com/environment/{environmentId}/statusesWithStages"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.qovery.com/environment/{environmentId}/statusesWithStages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qovery.com/environment/{environmentId}/statusesWithStages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.qovery.com/environment/{environmentId}/statusesWithStages"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.qovery.com/environment/{environmentId}/statusesWithStages")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/environment/{environmentId}/statusesWithStages")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "environment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_deployment_date": "2023-11-07T05:31:56Z",
    "last_deployment_id": "<string>",
    "total_deployment_duration_in_seconds": 123,
    "origin": "API",
    "triggered_by": "<string>",
    "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metrics": [
      {
        "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "total_duration_sec": 123,
        "details": [
          {
            "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "duration_sec": 123
          }
        ]
      }
    ]
  },
  "stages": [
    {
      "applications": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "is_part_last_deployment": true,
          "status_details": {
            "sub_action": "NONE"
          },
          "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "deployment_requests_count": 123,
          "last_deployment_date": "2023-11-07T05:31:56Z",
          "steps": {
            "total_duration_sec": 123,
            "total_computing_duration_sec": 123,
            "details": [
              {
                "duration_sec": 123
              }
            ]
          },
          "execution_id": "<string>"
        }
      ],
      "containers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "is_part_last_deployment": true,
          "status_details": {
            "sub_action": "NONE"
          },
          "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "deployment_requests_count": 123,
          "last_deployment_date": "2023-11-07T05:31:56Z",
          "steps": {
            "total_duration_sec": 123,
            "total_computing_duration_sec": 123,
            "details": [
              {
                "duration_sec": 123
              }
            ]
          },
          "execution_id": "<string>"
        }
      ],
      "jobs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "is_part_last_deployment": true,
          "status_details": {
            "sub_action": "NONE"
          },
          "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "deployment_requests_count": 123,
          "last_deployment_date": "2023-11-07T05:31:56Z",
          "steps": {
            "total_duration_sec": 123,
            "total_computing_duration_sec": 123,
            "details": [
              {
                "duration_sec": 123
              }
            ]
          },
          "execution_id": "<string>"
        }
      ],
      "databases": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "is_part_last_deployment": true,
          "status_details": {
            "sub_action": "NONE"
          },
          "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "deployment_requests_count": 123,
          "last_deployment_date": "2023-11-07T05:31:56Z",
          "steps": {
            "total_duration_sec": 123,
            "total_computing_duration_sec": 123,
            "details": [
              {
                "duration_sec": 123
              }
            ]
          },
          "execution_id": "<string>"
        }
      ],
      "helms": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "is_part_last_deployment": true,
          "status_details": {
            "sub_action": "NONE"
          },
          "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "deployment_requests_count": 123,
          "last_deployment_date": "2023-11-07T05:31:56Z",
          "steps": {
            "total_duration_sec": 123,
            "total_computing_duration_sec": 123,
            "details": [
              {
                "duration_sec": 123
              }
            ]
          },
          "execution_id": "<string>"
        }
      ],
      "terraforms": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "is_part_last_deployment": true,
          "status_details": {
            "sub_action": "NONE"
          },
          "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "deployment_requests_count": 123,
          "last_deployment_date": "2023-11-07T05:31:56Z",
          "steps": {
            "total_duration_sec": 123,
            "total_computing_duration_sec": 123,
            "details": [
              {
                "duration_sec": 123
              }
            ]
          },
          "execution_id": "<string>"
        }
      ],
      "stage": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "steps": {
          "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "total_duration_sec": 123,
          "details": [
            {
              "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "duration_sec": 123
            }
          ]
        }
      }
    }
  ],
  "pre_check_stage": {
    "total_duration_sec": 123
  }
}

Authorizations

bearerAuthApiKeyAuth

Authorization · string · header · required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

environmentId · string<uuid> · required

Environment ID

Response

200

application/json

Get statuses with stages

environment · object

Show child attributes

stages · object[]

Show child attributes

pre_check_stage · object

Show child attributes