Create an API key
curl --request POST \
--url http://localhost:6900/v1/system/api-keys \
--header 'Content-Type: application/json' \
--data '
{
"environment_id": "<string>",
"name": "<string>",
"scopes": []
}
'import requests
url = "http://localhost:6900/v1/system/api-keys"
payload = {
"environment_id": "<string>",
"name": "<string>",
"scopes": []
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({environment_id: '<string>', name: '<string>', scopes: []})
};
fetch('http://localhost:6900/v1/system/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_PORT => "6900",
CURLOPT_URL => "http://localhost:6900/v1/system/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([
'environment_id' => '<string>',
'name' => '<string>',
'scopes' => [
]
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:6900/v1/system/api-keys"
payload := strings.NewReader("{\n \"environment_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scopes\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:6900/v1/system/api-keys")
.header("Content-Type", "application/json")
.body("{\n \"environment_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scopes\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:6900/v1/system/api-keys")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"environment_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scopes\": []\n}"
response = http.request(request)
puts response.read_bodynullAPI Keys
Create an API key
Generates a new API key for programmatic access. The plain-text key is only returned once.
POST
/
v1
/
system
/
api-keys
Create an API key
curl --request POST \
--url http://localhost:6900/v1/system/api-keys \
--header 'Content-Type: application/json' \
--data '
{
"environment_id": "<string>",
"name": "<string>",
"scopes": []
}
'import requests
url = "http://localhost:6900/v1/system/api-keys"
payload = {
"environment_id": "<string>",
"name": "<string>",
"scopes": []
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({environment_id: '<string>', name: '<string>', scopes: []})
};
fetch('http://localhost:6900/v1/system/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_PORT => "6900",
CURLOPT_URL => "http://localhost:6900/v1/system/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([
'environment_id' => '<string>',
'name' => '<string>',
'scopes' => [
]
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:6900/v1/system/api-keys"
payload := strings.NewReader("{\n \"environment_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scopes\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:6900/v1/system/api-keys")
.header("Content-Type", "application/json")
.body("{\n \"environment_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scopes\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:6900/v1/system/api-keys")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"environment_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scopes\": []\n}"
response = http.request(request)
puts response.read_bodynull