Get install deploy status

curl --request GET \
  --url https://api.cnap.tech/v1/installs/{id}/status \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.cnap.tech/v1/installs/{id}/status', 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.cnap.tech/v1/installs/{id}/status",
  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.cnap.tech/v1/installs/{id}/status"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.cnap.tech/v1/installs/{id}/status")

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

{
  "install_id": "j572abc123def456",
  "health": "Healthy",
  "sync": "Synced",
  "revision": "abc123def",
  "resources": [
    {
      "kind": "<string>",
      "name": "<string>",
      "group": "<string>",
      "namespace": "<string>",
      "version": "<string>",
      "status": "<string>",
      "health": {
        "status": "<string>"
      }
    }
  ],
  "operation_phase": "Succeeded",
  "updated_at": 123
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

GET

installs

{id}

status

Get install deploy status

curl --request GET \
  --url https://api.cnap.tech/v1/installs/{id}/status \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.cnap.tech/v1/installs/{id}/status', 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.cnap.tech/v1/installs/{id}/status",
  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.cnap.tech/v1/installs/{id}/status"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.cnap.tech/v1/installs/{id}/status")

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

{
  "install_id": "j572abc123def456",
  "health": "Healthy",
  "sync": "Synced",
  "revision": "abc123def",
  "resources": [
    {
      "kind": "<string>",
      "name": "<string>",
      "group": "<string>",
      "namespace": "<string>",
      "version": "<string>",
      "status": "<string>",
      "health": {
        "status": "<string>"
      }
    }
  ],
  "operation_phase": "Succeeded",
  "updated_at": 123
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

Personal Access Token (cnap_pat_...) or OAuth2 JWT. Create tokens at https://cnap.tech/account/tokens

Path Parameters

string

required

Install ID

Response

Install deploy status

install_id

string

required

Example:

"j572abc123def456"

health

string | null

required

Example:

"Healthy"

sync

string | null

required

Example:

"Synced"

revision

string | null

required

Example:

"abc123def"

resources

object[] | null

required

Show child attributes

operation_phase

string | null

required

Example:

"Succeeded"

updated_at

number | null

required

Unix timestamp (seconds) when status was last updated via webhook

Overview

Endpoints

Get install deploy status

Authorizations

Path Parameters

Response