CPaaS Guide
API Endpoints
BlogLogin

API Management

Learn how to use API keys API V6.

Overview

The API Keys allows you to create, read, update, and delete API keys, as well as control their access by assigning scopes. This ensures fine-grained permission control for all API integrations.

📘

Important Points to Remember

  • All endpoints require authentication via the Authorization: Bearer <api_key> header.
  • API keys must have at least one scope.
  • Scope values are case-sensitive.
  • API keys are shown only once upon creation.
  • Single IP addresses are auto-converted to /32 CIDR format.
  • All timestamps are in ISO 8601 format.
  • Maximum of 1000 records per listing page.

Available Endpoints

Endpoint NameMethodEndpointDescription
Create API KeyPOST/v6/api_keysCreates a new API key with specified scopes and optional IP restrictions.
List API KeysGET/v6/api_keysRetrieves a paginated list of all API keys under the account.
Get API KeyGET/v6/api_keys/{api_key_id}Fetches details of a specific API key including scopes and IPs.
Update API KeyPUT/v6/api_keys/{api_key_id}Updates an existing API key's name, scopes, or IP restrictions.
Delete API KeyDELETE/v6/api_keys/{api_key_id}Permanently deletes the specified API key.
Get Available ScopesGET/v6/scopesRetrieves the full list of supported permission scopes.

Important Points to Remember

  • API keys are displayed only once at the time of creation. Store them securely.

  • API key names must be unique within a client account.

  • Each API key must have at least one valid scope.

  • Scopes are case-sensitive and must match exactly with supported values.

  • IP addresses must be in valid IPv4 format or CIDR notation.

    • Single IPs like 192.168.0.1 are auto-converted to 192.168.0.1/32.

  • Maximum of 1000 records per request is allowed when listing API keys.

  • API keys support two permission modes:

    • Full access (permission=1)
    • Scoped access (permission=2)

  • All timestamps in responses follow the ISO 8601 format (e.g., 2025-06-23T10:15:30Z).

  • API key updates are atomic: either all changes apply successfully, or none do.

Let me know if you’d like to include this directly into a Markdown file or combine with any other API sections.