curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cdf-version: <cdf-version>' \
--data '
{
"filter": {
"prefix": {
"property": [
"limitId"
],
"value": "atlas."
}
},
"limit": 1000,
"cursor": "string"
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list"
payload = {
"filter": { "prefix": {
"property": ["limitId"],
"value": "atlas."
} },
"limit": 1000,
"cursor": "string"
}
headers = {
"cdf-version": "<cdf-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'cdf-version': '<cdf-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filter: {prefix: {property: ['limitId'], value: 'atlas.'}},
limit: 1000,
cursor: 'string'
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list', 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://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'prefix' => [
'property' => [
'limitId'
],
'value' => 'atlas.'
]
],
'limit' => 1000,
'cursor' => 'string'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"cdf-version: <cdf-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list"
payload := strings.NewReader("{\n \"filter\": {\n \"prefix\": {\n \"property\": [\n \"limitId\"\n ],\n \"value\": \"atlas.\"\n }\n },\n \"limit\": 1000,\n \"cursor\": \"string\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cdf-version", "<cdf-version>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list")
.header("cdf-version", "<cdf-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"prefix\": {\n \"property\": [\n \"limitId\"\n ],\n \"value\": \"atlas.\"\n }\n },\n \"limit\": 1000,\n \"cursor\": \"string\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cdf-version"] = '<cdf-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"prefix\": {\n \"property\": [\n \"limitId\"\n ],\n \"value\": \"atlas.\"\n }\n },\n \"limit\": 1000,\n \"cursor\": \"string\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"limitId": "atlas.monthly_ai_tokens",
"value": 1000
},
{
"limitId": "atlas.monthly_ai_prompts",
"value": 500
}
],
"nextCursor": "eyJjdXJzb3IiOiAiMTIzNDU2In0="
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Advanced list of limit values.
Required capabilities:
projectsAcl:LIST
Retrieves limit values using a filter.
Only the prefix operator is supported.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cdf-version: <cdf-version>' \
--data '
{
"filter": {
"prefix": {
"property": [
"limitId"
],
"value": "atlas."
}
},
"limit": 1000,
"cursor": "string"
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list"
payload = {
"filter": { "prefix": {
"property": ["limitId"],
"value": "atlas."
} },
"limit": 1000,
"cursor": "string"
}
headers = {
"cdf-version": "<cdf-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'cdf-version': '<cdf-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filter: {prefix: {property: ['limitId'], value: 'atlas.'}},
limit: 1000,
cursor: 'string'
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list', 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://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'prefix' => [
'property' => [
'limitId'
],
'value' => 'atlas.'
]
],
'limit' => 1000,
'cursor' => 'string'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"cdf-version: <cdf-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list"
payload := strings.NewReader("{\n \"filter\": {\n \"prefix\": {\n \"property\": [\n \"limitId\"\n ],\n \"value\": \"atlas.\"\n }\n },\n \"limit\": 1000,\n \"cursor\": \"string\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cdf-version", "<cdf-version>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list")
.header("cdf-version", "<cdf-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"prefix\": {\n \"property\": [\n \"limitId\"\n ],\n \"value\": \"atlas.\"\n }\n },\n \"limit\": 1000,\n \"cursor\": \"string\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/limits/values/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cdf-version"] = '<cdf-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"prefix\": {\n \"property\": [\n \"limitId\"\n ],\n \"value\": \"atlas.\"\n }\n },\n \"limit\": 1000,\n \"cursor\": \"string\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"limitId": "atlas.monthly_ai_tokens",
"value": 1000
},
{
"limitId": "atlas.monthly_ai_prompts",
"value": 500
}
],
"nextCursor": "eyJjdXJzb3IiOiAiMTIzNDU2In0="
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Headers
20230101-alpha Body
Request body for list endpoints with filtering options.
Filter to apply to the list operation. To retrieve all limits for a specific service,
use the "prefix" operator where the property is the limit's key, e.g.,
{"prefix": {"property": ["limitId"], "value": "atlas."}}
Show child attributes
Show child attributes
Maximum number of items to return.
x <= 1000Cursor to use for paging through results.
Was this page helpful?