List quota usage for the authenticated user - CNAP | Docs

List quota usage for the authenticated user

curl --request GET \
  --url https://api.cnap.tech/v1/quotas \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.cnap.tech/v1/quotas', 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/quotas",
  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/quotas"

	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/quotas")

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

[
  {
    "metric": "compute/machines",
    "type": "allocation",
    "display_name": "Compute machines",
    "unit": "count",
    "limit": 1,
    "usage": 0,
    "remaining": 1,
    "resets_at": "<string>"
  }
]

GET

/

v1

/

quotas

List quota usage for the authenticated user

curl --request GET \
  --url https://api.cnap.tech/v1/quotas \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.cnap.tech/v1/quotas', 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/quotas",
  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/quotas"

	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/quotas")

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

[
  {
    "metric": "compute/machines",
    "type": "allocation",
    "display_name": "Compute machines",
    "unit": "count",
    "limit": 1,
    "usage": 0,
    "remaining": 1,
    "resets_at": "<string>"
  }
]

Authorizations

Authorization

string

header

required

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

Query Parameters

cluster_id

string

Cluster ID to include concurrency quotas

Response

Quota info for all metrics

metric

string

required

Metric: service/resource

Example:

"compute/machines"

type

enum<string>

required

Available options:

allocation,

rate,

concurrency

Example:

"allocation"

display_name

string

required

Example:

"Compute machines"

unit

string

required

count, cores, bytes, count/day

Example:

"count"

limit

number

required

Example:

1

usage

number

required

Example:

0

remaining

number

required

Example:

1

resets_at

string

For rate quotas: ISO 8601 reset time