Generate an API key for an application

POST

/api/v1/apps/{appId}/apikeys

Creates a new API key associated with the specified application. Requires JWT authentication and the user must be an Admin or Owner of the application's organization. Owners get all permissions; Admins get requested permissions.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://useraccounts.srblabs.io/api/v1/apps//apikeys' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Analytics Service Key",
    "expires_in_days": 90,
    "permissions": [
        "event:record",
        "inventory:write"
    ]
}'

Response Example

201 - Example 1

{
    "api_key_details": {
        "application_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
        "created_at": "2023-10-26T11:00:00Z",
        "description": "CI/CD Deployment Key",
        "expires_at": "2024-10-25T11:00:00Z",
        "id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
        "key_prefix": "ask_abcd",
        "last_used": "2023-10-26T11:00:00Z",
        "permissions": [
            "event:record",
            "inventory:read"
        ],
        "revoked_at": "2023-11-01T09:00:00Z"
    },
    "raw_key": "ask_abcd1234xyz..............................."
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

API Key created successfully. Includes the raw key (only shown once).

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Modified at 2025-05-03 01:39:03

List API keys for an application

Get current user's profile