Indox Auth API - OSLLM AI

API Keys

Download schema

List API keys for current user.

GET

/auth/api/v1/api-keys/

Return all API keys for the authenticated user.

List API keys for current user. › Responses

List response for user's API keys.

max_keys

integer · required

active_count

integer · required

total_keys

integer · required

object · required

Aggregated usage stats for all of a user's API keys.

object[] · required

GET/auth/api/v1/api-keys/

import requests

url = "/auth/api/v1/api-keys/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "max_keys": 0,
  "active_count": 0,
  "total_keys": 0,
  "usage_summary": {
    "total_requests_last_hour": 0,
    "total_requests_last_30_days": 0,
    "total_requests": 0,
    "rate_limit_used_last_hour": 0,
    "rate_limit_per_hour": 0,
    "rate_limit_remaining": 0,
    "rate_limit_usage_percent": 0
  },
  "keys": [
    {
      "id": 0,
      "name": "name",
      "permissions": [
        "string"
      ],
      "is_active": true,
      "created_at": "created_at",
      "last_used": "string",
      "expires_at": "string",
      "ip_whitelist": [
        "string"
      ],
      "rate_limit_per_hour": 0,
      "masked_key": "masked_key",
      "total_requests": 0,
      "requests_last_hour": 0,
      "rate_limit_used_last_hour": 0,
      "rate_limit_remaining": 0,
      "rate_limit_usage_percent": 0
    }
  ]
}

json

application/json

Create a new API key (plaintext shown once).

POST

/auth/api/v1/api-keys/

Create an API key and return the plaintext version once.

Create a new API key (plaintext shown once). › Request Body

Payload for creating a new API key.

name

string · maxLength: 100 · required

Label shown in dashboards, e.g. 'Internal Service'.

permissions

string[]

Permission scopes granted to the API key.

Optional expiration window in days (0 means never expires).

never_expires

boolean

If true the API key stays active until revoked manually even if expires_in_days is omitted.

Default: true

Optional list of IPv4/IPv6 addresses allowed to use this key.

Override default hourly request cap for this key.

Create a new API key (plaintext shown once). › Responses

Created

Response containing metadata and the one-time raw API key.

id

integer · required

name

string · required

permissions

string[] · required

is_active

boolean · required

created_at

string · required

rate_limit_per_hour

integer · required

raw_key

string · required

Plaintext API key. Shown exactly once on creation.

ip_whitelist

string[]

masked_key

string

Non-sensitive preview of the API key so the user can recognize it later.

Default:

total_requests

integer

Total requests ever made with this API key.

Default: 0

requests_last_hour

integer

Number of requests made with this key in the last hour.

Default: 0

rate_limit_used_last_hour

integer

Requests counted toward the current hourly rate limit window.

Default: 0

rate_limit_remaining

integer

Remaining requests in the current hourly rate limit window.

Default: 0

rate_limit_usage_percent

number

Percent of the hourly rate limit consumed (0-100).

Default: 0

POST/auth/api/v1/api-keys/

import requests

url = "/auth/api/v1/api-keys/"

payload = {
    "name": "name",
    "permissions": ["string"],
    "expires_in_days": 0,
    "never_expires": True,
    "ip_whitelist": ["string"],
    "rate_limit_per_hour": 0
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "name": "name",
  "permissions": [
    "string"
  ],
  "expires_in_days": 0,
  "never_expires": true,
  "ip_whitelist": [
    "string"
  ],
  "rate_limit_per_hour": 0
}

json

Example Responses

{
  "id": 0,
  "name": "name",
  "permissions": [
    "string"
  ],
  "is_active": true,
  "created_at": "created_at",
  "last_used": "string",
  "expires_at": "string",
  "ip_whitelist": [
    "string"
  ],
  "rate_limit_per_hour": 0,
  "masked_key": "masked_key",
  "total_requests": 0,
  "requests_last_hour": 0,
  "rate_limit_used_last_hour": 0,
  "rate_limit_remaining": 0,
  "rate_limit_usage_percent": 0,
  "raw_key": "raw_key"
}

json

application/json

Revoke (delete) an API key.

DELETE

/auth/api/v1/api-keys/{key_id}/

Soft-delete an API key by marking it inactive.

Revoke (delete) an API key. › path Parameters

key_id

integer · required

Revoke (delete) an API key. › Responses

Generic response for destructive operations.

message

string · required

key_id

integer · required

active_count

integer · required

DELETE/auth/api/v1/api-keys/{key_id}/

import requests

url = "/auth/api/v1/api-keys/:key_id/"

response = requests.delete(url)

print(response.text)

python

Example Responses

{
  "message": "message",
  "key_id": 0,
  "active_count": 0
}

json

application/json

Device Management and Session Management User Storage

List API keys for current user.

GET

/auth/api/v1/api-keys/

Return all API keys for the authenticated user.

List API keys for current user. › Responses

List response for user's API keys.

max_keys

integer · required

active_count

integer · required

total_keys

integer · required

object · required

Aggregated usage stats for all of a user's API keys.

object[] · required

{ "max_keys": 0, "active_count": 0, "total_keys": 0, "usage_summary": { "total_requests_last_hour": 0, "total_requests_last_30_days": 0, "total_requests": 0, "rate_limit_used_last_hour": 0, "rate_limit_per_hour": 0, "rate_limit_remaining": 0, "rate_limit_usage_percent": 0 }, "keys": [ { "id": 0, "name": "name", "permissions": [ "string" ], "is_active": true, "created_at": "created_at", "last_used": "string", "expires_at": "string", "ip_whitelist": [ "string" ], "rate_limit_per_hour": 0, "masked_key": "masked_key", "total_requests": 0, "requests_last_hour": 0, "rate_limit_used_last_hour": 0, "rate_limit_remaining": 0, "rate_limit_usage_percent": 0 } ] }

Create a new API key (plaintext shown once).

POST

/auth/api/v1/api-keys/

Create an API key and return the plaintext version once.

Create a new API key (plaintext shown once). › Request Body

Payload for creating a new API key.

name

string · maxLength: 100 · required

Label shown in dashboards, e.g. 'Internal Service'.

permissions

string[]

Permission scopes granted to the API key.

Optional expiration window in days (0 means never expires).

never_expires

boolean

If true the API key stays active until revoked manually even if expires_in_days is omitted.

Default: true

Optional list of IPv4/IPv6 addresses allowed to use this key.

Override default hourly request cap for this key.

Create a new API key (plaintext shown once). › Responses

Created

Response containing metadata and the one-time raw API key.

id

integer · required

name

string · required

permissions

string[] · required

is_active

boolean · required

created_at

string · required

rate_limit_per_hour

integer · required

raw_key

string · required

Plaintext API key. Shown exactly once on creation.

ip_whitelist

string[]

masked_key

string

Non-sensitive preview of the API key so the user can recognize it later.

Default:

total_requests

integer

Total requests ever made with this API key.

Default: 0

requests_last_hour

integer

Number of requests made with this key in the last hour.

Default: 0

rate_limit_used_last_hour

integer

Requests counted toward the current hourly rate limit window.

Default: 0

rate_limit_remaining

integer

Remaining requests in the current hourly rate limit window.

Default: 0

rate_limit_usage_percent

number

Percent of the hourly rate limit consumed (0-100).

Default: 0

import requests url = "/auth/api/v1/api-keys/" payload = { "name": "name", "permissions": ["string"], "expires_in_days": 0, "never_expires": True, "ip_whitelist": ["string"], "rate_limit_per_hour": 0 } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.text)

{ "id": 0, "name": "name", "permissions": [ "string" ], "is_active": true, "created_at": "created_at", "last_used": "string", "expires_at": "string", "ip_whitelist": [ "string" ], "rate_limit_per_hour": 0, "masked_key": "masked_key", "total_requests": 0, "requests_last_hour": 0, "rate_limit_used_last_hour": 0, "rate_limit_remaining": 0, "rate_limit_usage_percent": 0, "raw_key": "raw_key" }

Revoke (delete) an API key.

DELETE

/auth/api/v1/api-keys/{key_id}/

Soft-delete an API key by marking it inactive.

Revoke (delete) an API key. › path Parameters

key_id

integer · required

Revoke (delete) an API key. › Responses

Generic response for destructive operations.

message

string · required

key_id

integer · required

active_count

integer · required