Create a new API key for a user

POST

https://example.com

api

auth

api-key

create

Create a new API key for a user

curl --request POST \
  --url https://example.com/api/auth/api-key/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expiresIn": null,
  "remaining": null
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({expiresIn: null, remaining: null})
};

fetch('https://example.com/api/auth/api-key/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://example.com/api/auth/api-key/create"

payload = {
    "expiresIn": None,
    "remaining": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://example.com/api/auth/api-key/create"

	payload := strings.NewReader("{\n  \"expiresIn\": null,\n  \"remaining\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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))

}

{
  "createdAt": "2023-11-07T05:31:56Z",
  "enabled": true,
  "id": "<string>",
  "key": "<string>",
  "rateLimitEnabled": true,
  "referenceId": "<string>",
  "requestCount": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "lastRefillAt": "2023-11-07T05:31:56Z",
  "lastRequest": "2023-11-07T05:31:56Z",
  "metadata": {},
  "name": "<string>",
  "permissions": {},
  "prefix": "<string>",
  "rateLimitMax": 123,
  "rateLimitTimeWindow": 123,
  "refillAmount": 123,
  "refillInterval": 123,
  "remaining": 123,
  "start": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer token authentication

Body

application/json

expiresIn

string

required

remaining

string

required

configId

string | null

The configuration ID to use for the API key. If not provided, the default configuration will be used.

metadata

string | null

name

string | null

Name of the Api Key

organizationId

string | null

Organization Id of the organization that the Api Key belongs to. Eg: 'org-id'

permissions

string | null

Permissions of the Api Key.

prefix

string | null

Prefix of the Api Key

rateLimitEnabled

boolean | null

Whether the key has rate limiting enabled. server-only. Eg: true

rateLimitMax

number | null

Maximum amount of requests allowed within a window. Once the maxRequests is reached, the request will be rejected until the timeWindow has passed, at which point the timeWindow will be reset. server-only. Eg: 100

rateLimitTimeWindow

number | null

The duration in milliseconds where each request is counted. Once the maxRequests is reached, the request will be rejected until the timeWindow has passed, at which point the timeWindow will be reset. server-only. Eg: 1000

refillAmount

number | null

Amount to refill the remaining count of the Api Key. server-only. Eg: 100

refillInterval

number | null

Interval to refill the Api Key in milliseconds. server-only. Eg: 1000

userId

string | null

User Id of the user that the Api Key belongs to. server-only. Eg: "user-id"

Response

API key created successfully

createdAt

string<date-time>

required

Creation timestamp

enabled

boolean

required

Whether the key is enabled

string

required

Unique identifier of the API key

key

string

required

The full API key (only returned on creation)

rateLimitEnabled

boolean

required

Whether rate limiting is enabled

referenceId

string

required

ID of the reference owning the key

requestCount

number

required

Current request count in window

updatedAt

string<date-time>

required

Last update timestamp

expiresAt

string<date-time> | null

Expiration timestamp

lastRefillAt

string<date-time> | null

Last refill timestamp

lastRequest

string<date-time> | null

Last request timestamp

metadata

object | null

Metadata associated with the key

name

string | null

Name of the API key

permissions

object | null

Permissions associated with the key

Show child attributes

prefix

string | null

Prefix of the API key

rateLimitMax

number | null

Maximum requests in time window

rateLimitTimeWindow

number | null

Rate limit time window in milliseconds

refillAmount

number | null

Amount to refill

refillInterval

number | null

Refill interval in milliseconds

remaining

number | null

Remaining requests

start

string | null

Starting characters of the key (if configured)

List all API keys for the authenticated user or for a specific organizationList all API keys for the authenticated user or for a specific organization

Create a new API key for a user

curl --request POST \
  --url https://example.com/api/auth/api-key/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expiresIn": null,
  "remaining": null
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({expiresIn: null, remaining: null})
};

fetch('https://example.com/api/auth/api-key/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://example.com/api/auth/api-key/create"

payload = {
    "expiresIn": None,
    "remaining": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://example.com/api/auth/api-key/create"

	payload := strings.NewReader("{\n  \"expiresIn\": null,\n  \"remaining\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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))

}

{
  "createdAt": "2023-11-07T05:31:56Z",
  "enabled": true,
  "id": "<string>",
  "key": "<string>",
  "rateLimitEnabled": true,
  "referenceId": "<string>",
  "requestCount": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "lastRefillAt": "2023-11-07T05:31:56Z",
  "lastRequest": "2023-11-07T05:31:56Z",
  "metadata": {},
  "name": "<string>",
  "permissions": {},
  "prefix": "<string>",
  "rateLimitMax": 123,
  "rateLimitTimeWindow": 123,
  "refillAmount": 123,
  "refillInterval": 123,
  "remaining": 123,
  "start": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}