Create a new org-level API key. Only org admins can create API keys.
POST
/
api_keys
Create API Key
curl --request POST \
--url https://api.example.com/api_keys \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"scopes": [
{
"resource_id": "<string>",
"resource_type": "<string>"
}
],
"sharing_group_ids": [
"<string>"
],
"description": "<string>"
}
'import requests
url = "https://api.example.com/api_keys"
payload = {
"name": "<string>",
"scopes": [
{
"resource_id": "<string>",
"resource_type": "<string>"
}
],
"sharing_group_ids": ["<string>"],
"description": "<string>"
}
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({
name: '<string>',
scopes: [{resource_id: '<string>', resource_type: '<string>'}],
sharing_group_ids: ['<string>'],
description: '<string>'
})
};
fetch('https://api.example.com/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.example.com/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>',
'scopes' => [
[
'resource_id' => '<string>',
'resource_type' => '<string>'
]
],
'sharing_group_ids' => [
'<string>'
],
'description' => '<string>'
]),
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 := "https://api.example.com/api_keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"scopes\": [\n {\n \"resource_id\": \"<string>\",\n \"resource_type\": \"<string>\"\n }\n ],\n \"sharing_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\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("https://api.example.com/api_keys")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"scopes\": [\n {\n \"resource_id\": \"<string>\",\n \"resource_type\": \"<string>\"\n }\n ],\n \"sharing_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api_keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"scopes\": [\n {\n \"resource_id\": \"<string>\",\n \"resource_type\": \"<string>\"\n }\n ],\n \"sharing_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"api_key": {
"created_by": "<string>",
"id": "<string>",
"key_prefix": "<string>",
"name": "<string>",
"org_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"last_used_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"scopes": [
{
"resource_id": "<string>",
"resource_type": "<string>"
}
],
"sharing_group_ids": [
"<string>"
]
},
"key": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Store the returned
api_key securely - it will not be shown again.Body
application/json
Request model for creating an API key.
Human-readable name for the API key.
Required string length:
1 - 256List of resource scopes. At least one scope is required.
Minimum array length:
1Show child attributes
Show child attributes
IDs of groups that receive default admin grants on key-created resources.
Minimum array length:
1Optional description.
Maximum string length:
1000Was this page helpful?
⌘I
Create API Key
curl --request POST \
--url https://api.example.com/api_keys \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"scopes": [
{
"resource_id": "<string>",
"resource_type": "<string>"
}
],
"sharing_group_ids": [
"<string>"
],
"description": "<string>"
}
'import requests
url = "https://api.example.com/api_keys"
payload = {
"name": "<string>",
"scopes": [
{
"resource_id": "<string>",
"resource_type": "<string>"
}
],
"sharing_group_ids": ["<string>"],
"description": "<string>"
}
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({
name: '<string>',
scopes: [{resource_id: '<string>', resource_type: '<string>'}],
sharing_group_ids: ['<string>'],
description: '<string>'
})
};
fetch('https://api.example.com/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.example.com/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>',
'scopes' => [
[
'resource_id' => '<string>',
'resource_type' => '<string>'
]
],
'sharing_group_ids' => [
'<string>'
],
'description' => '<string>'
]),
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 := "https://api.example.com/api_keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"scopes\": [\n {\n \"resource_id\": \"<string>\",\n \"resource_type\": \"<string>\"\n }\n ],\n \"sharing_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\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("https://api.example.com/api_keys")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"scopes\": [\n {\n \"resource_id\": \"<string>\",\n \"resource_type\": \"<string>\"\n }\n ],\n \"sharing_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api_keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"scopes\": [\n {\n \"resource_id\": \"<string>\",\n \"resource_type\": \"<string>\"\n }\n ],\n \"sharing_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"api_key": {
"created_by": "<string>",
"id": "<string>",
"key_prefix": "<string>",
"name": "<string>",
"org_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"last_used_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"scopes": [
{
"resource_id": "<string>",
"resource_type": "<string>"
}
],
"sharing_group_ids": [
"<string>"
]
},
"key": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}