Settings
Create API key
Creates a new API key for the specified tenant
POST
/
api
/
v1
/
settings
/
api-keys
Create API key
curl --request POST \
--url https://api.costgraph.ai/api/v1/settings/api-keys \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"tenant_id": "<string>",
"permission_scopes": [],
"tags": {},
"ttl_hours": 12
}
'import requests
url = "https://api.costgraph.ai/api/v1/settings/api-keys"
payload = {
"name": "<string>",
"tenant_id": "<string>",
"permission_scopes": [],
"tags": {},
"ttl_hours": 12
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
tenant_id: '<string>',
permission_scopes: [],
tags: {},
ttl_hours: 12
})
};
fetch('https://api.costgraph.ai/api/v1/settings/api-keys', 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.costgraph.ai/api/v1/settings/api-keys",
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([
'name' => '<string>',
'tenant_id' => '<string>',
'permission_scopes' => [
],
'tags' => [
],
'ttl_hours' => 12
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.costgraph.ai/api/v1/settings/api-keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"permission_scopes\": [],\n \"tags\": {},\n \"ttl_hours\": 12\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.costgraph.ai/api/v1/settings/api-keys")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"permission_scopes\": [],\n \"tags\": {},\n \"ttl_hours\": 12\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/settings/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"permission_scopes\": [],\n \"tags\": {},\n \"ttl_hours\": 12\n}"
response = http.request(request)
puts response.read_body{
"message": "some message",
"status": "success",
"data": {
"active": true,
"created_at": "<string>",
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"permission_scopes": [
"<string>"
],
"tenant_id": "<string>",
"costgraph_product": "<string>",
"expires_at": "<string>",
"last_four": "<string>",
"last_used_at": "<string>",
"raw_api_key": "<string>"
}
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}Authorizations
Enter "Bearer {token}"
Body
application/json
API key details
Available options:
costgraph-agent, costgraph-operator Available options:
user, install_token Available options:
agent:read, agent:write, operator:read, operator:write, focus:read, focus:write, pricing:read, pricing:write Show child attributes
Show child attributes
Required range:
1 <= x <= 24Was this page helpful?
⌘I
Create API key
curl --request POST \
--url https://api.costgraph.ai/api/v1/settings/api-keys \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"tenant_id": "<string>",
"permission_scopes": [],
"tags": {},
"ttl_hours": 12
}
'import requests
url = "https://api.costgraph.ai/api/v1/settings/api-keys"
payload = {
"name": "<string>",
"tenant_id": "<string>",
"permission_scopes": [],
"tags": {},
"ttl_hours": 12
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
tenant_id: '<string>',
permission_scopes: [],
tags: {},
ttl_hours: 12
})
};
fetch('https://api.costgraph.ai/api/v1/settings/api-keys', 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.costgraph.ai/api/v1/settings/api-keys",
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([
'name' => '<string>',
'tenant_id' => '<string>',
'permission_scopes' => [
],
'tags' => [
],
'ttl_hours' => 12
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.costgraph.ai/api/v1/settings/api-keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"permission_scopes\": [],\n \"tags\": {},\n \"ttl_hours\": 12\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.costgraph.ai/api/v1/settings/api-keys")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"permission_scopes\": [],\n \"tags\": {},\n \"ttl_hours\": 12\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/settings/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"permission_scopes\": [],\n \"tags\": {},\n \"ttl_hours\": 12\n}"
response = http.request(request)
puts response.read_body{
"message": "some message",
"status": "success",
"data": {
"active": true,
"created_at": "<string>",
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"permission_scopes": [
"<string>"
],
"tenant_id": "<string>",
"costgraph_product": "<string>",
"expires_at": "<string>",
"last_four": "<string>",
"last_used_at": "<string>",
"raw_api_key": "<string>"
}
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}