Create API key
curl --request POST \
--url http://localhost:3000/v1/admin/api-keys \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"scopes": [],
"expires_at": "2023-11-07T05:31:56Z",
"staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "http://localhost:3000/v1/admin/api-keys"
payload = {
"name": "<string>",
"description": "<string>",
"scopes": [],
"expires_at": "2023-11-07T05:31:56Z",
"staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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>',
description: '<string>',
scopes: [],
expires_at: '2023-11-07T05:31:56Z',
staff_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('http://localhost:3000/v1/admin/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 => "3000",
CURLOPT_URL => "http://localhost:3000/v1/admin/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>',
'description' => '<string>',
'scopes' => [
],
'expires_at' => '2023-11-07T05:31:56Z',
'staff_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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:3000/v1/admin/api-keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"scopes\": [],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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:3000/v1/admin/api-keys")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"scopes\": [],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v1/admin/api-keys")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"scopes\": [],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"key_prefix": "<string>",
"key_last_four": "<string>",
"staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"scopes": [
"<string>"
],
"is_active": true,
"expires_at": "<string>",
"last_used_at": "<string>",
"usage_count": 123,
"created_at": "<string>",
"updated_at": "<string>",
"revoked_at": "<string>",
"staff": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
},
"secret": "<string>"
}API Keys
Create API key
Creates a new API key. The secret is only returned once and cannot be retrieved later.
POST
/
v1
/
admin
/
api-keys
Create API key
curl --request POST \
--url http://localhost:3000/v1/admin/api-keys \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"scopes": [],
"expires_at": "2023-11-07T05:31:56Z",
"staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "http://localhost:3000/v1/admin/api-keys"
payload = {
"name": "<string>",
"description": "<string>",
"scopes": [],
"expires_at": "2023-11-07T05:31:56Z",
"staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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>',
description: '<string>',
scopes: [],
expires_at: '2023-11-07T05:31:56Z',
staff_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('http://localhost:3000/v1/admin/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 => "3000",
CURLOPT_URL => "http://localhost:3000/v1/admin/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>',
'description' => '<string>',
'scopes' => [
],
'expires_at' => '2023-11-07T05:31:56Z',
'staff_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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:3000/v1/admin/api-keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"scopes\": [],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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:3000/v1/admin/api-keys")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"scopes\": [],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v1/admin/api-keys")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"scopes\": [],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"key_prefix": "<string>",
"key_last_four": "<string>",
"staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"scopes": [
"<string>"
],
"is_active": true,
"expires_at": "<string>",
"last_used_at": "<string>",
"usage_count": 123,
"created_at": "<string>",
"updated_at": "<string>",
"revoked_at": "<string>",
"staff": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
},
"secret": "<string>"
}Body
application/json
⌘I