API Usage Guide

Authentication

The Soracom API uses API Key and API Token authentication. First, obtain a token by sending your credentials to the auth/issueToken endpoint, then include the token in the Authorization header of subsequent requests.

1. Create an API Key and API Token in the Soracom console
2. POST to /v1/auth to authenticate and receive an API token
3. Include the X-Soracom-API-Key and X-Soracom-Token headers in all subsequent requests

Base URLs

The Soracom API provides two endpoints corresponding to global and Japan coverage types.

Pagination

List endpoints use cursor-based pagination. Pass the last_evaluated_key from the response as a query parameter in the next request to fetch the next page of results.

Rate Limits

API requests are subject to rate limiting. When the limit is exceeded, a 429 status code is returned. Check the Retry-After header to determine how long to wait before retrying.

Error Handling

The Soracom API returns standard HTTP status codes. Error responses include a code and message field that describe the issue in detail.

• 400 - Invalid request parameters
• 401 - Authentication required or token expired
• 403 - Insufficient permissions for this resource
• 404 - Resource not found
• 429 - Rate limit exceeded

See Also

View the full API Reference{.ds-button.--primary}