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.
- Create an API Key and API Token in the Soracom console
- POST to /v1/auth to authenticate and receive an API token
- 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.
| Coverage Type | Base URL |
|---|---|
| Global Coverage | https://g.api.soracom.io/v1 |
| Japan Coverage | https://api.soracom.io/v1 |
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 parameters401- Authentication required or token expired403- Insufficient permissions for this resource404- Resource not found429- Rate limit exceeded
See Also
View the full API Reference{.ds-button.--primary}