v11

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-017364211.0 KB

API Keys

Create API Key

Creates a new API Key to access SDP endpoints. API Key can be configured to have a granular read/write access, also API key can be restricted to the specific IP or range of the IPs.

post/api-keys

Request body

namestring required

Human-readable name for the API key

permissionsstring[] required

List of permissions granted to this API key

expiry_datestring date-time

Optional expiration date for the API key (must be in the future)

Response

API key created successfully

idstring

Unique identifier for the API key

namestring

Human-readable name for the API key

keystring

The actual API key (only returned once at creation)

permissionsstring[]

List of permissions granted to this API key

allowed_ipsstring[]

List of allowed IP addresses or CIDR ranges

expiry_datestring date-time

Expiration date of the API key

created_atstring date-time

When the API key was created

created_bystring

User who created the API key

updated_atstring date-time

When the API key was last updated

updated_bystring

User who last updated the API key

last_used_atstring date-time

When the API key was last used