Developer APIResources

API Platform

The API Platform APIs allow users to programmatically create and manage API Platform assets like endpoints, collections, clients, and access profiles.

API platform endpoints allow up to 10 requests per second.

DEPRECATION NOTICE

The following endpoints are scheduled for deprecation on December 1, 2025:

Migrate to the following endpoints before this date to avoid service interruptions:

Quick reference

TypeResourceDescription
GET/api/api_collectionsList API collections
POST/api/api_collectionsCreate an API collection
GET/api/api_endpointsList API endpoints
PUT/api/api_endpoints/:api_endpoint_id/disableDisable an API endpoint
PUT/api/api_endpoints/:api_endpoint_id/enableEnable an API endpoint
GET/api/api_clientsList API clients
GET/api/v2/api_clientsList API clients (v2)
POST/api/api_clientsCreate an API client
POST/api/v2/api_clientsCreate an API client (v2)
GET/api/v2/api_clients/:api_client_idRetrieves details of an API client by its unique ID.
GET/api/api_access_profilesList access profiles belonging to an API client
POST/api/api_access_profilesCreate an access profile belonging to an API client
PUT/api/api_access_profiles/:api_access_profile_idUpdate an access profile belonging to an API client
PUT/api/api_access_profiles/:api_access_profile_id/disableDisable an access profile
PUT/api/api_access_profiles/:api_access_profile_id/enableEnable an access profile
PUT/api/api_access_profiles/:api_access_profile_id/refresh_secretRefresh token secret or oauth client secret
GET/api/v2/api_clients/api_client_id/api_keysRetrieves all API keys for an API client.
POST/api/v2/api_clients/api_client_id/api_keysCreates a new API key for an API client.
PUT/api/v2/api_clients/api_client_id/api_keys/api_key_idUpdates an existing API key for an API client.
PUT/api/v2/api_clients/api_client_id/api_keys/api_key_id/enableEnables an API key for an API client, allowing it to make authenticated requests.
PUT/api/v2/api_clients/api_client_id/api_keys/api_key_id/disableDisables an API key for an API client, preventing it from making API requests.
PUT/api/v2/api_clients/api_client_id/api_keys/api_key_id/refresh_secretRefreshes the authentication token or OAuth 2.0 client secret for an API key.
GET/api/v2/api_portalsRetrieves a list of all API portals associated with API clients in your workspace.
GET/api/cert_bundlesList all certificate bundles.
POST/api/cert_bundlesCreate a new certificate bundle.
PUT/api/cert_bundles/:certificate_bundle_idUpdate a certificate bundle.
DELETE/api/cert_bundles/:certificate_bundle_idDelete a certificate bundle.
GET/api/cert_bundles/certificate_bundle_id/downloadDownload the certificate bundle PEM file.