We're updating the API path structure for several Sentinel Hub APIs to improve consistency across our APIs. This change will be gradually rolled out starting on Tuesday, March 17th over the course of the following week.
Affected services:
- Processing API
- Asynchronous Processing API
- Statistical API
- Batch Statistical API
- Batch Processing API
- Catalog API
- Zarr Import API
- Bring Your Own COG (BYOC) API
What’s Changing
API endpoints are transitioning from:
- Current format: /api/<version>/<service>
- New format: /<service>/<version>
Examples:
| Current Format | New Format |
| /api/v1/process | /process/v1 |
| /api/v1/async | /async/v1 |
| /api/v1/statistics | /statistics/v1 |
| /api/v1/statistics/batch | /statistics/batch/v1 |
| /api/v2/batch | /batch/v2 |
| /api/v1/catalog/1.0.0 | /catalog/v1 |
| /api/v1/zarr | /zarr/v1 |
| /api/v1/byoc | /byoc/v1 |
Impact
- Both URL formats will continue to work - No action is required from API consumers
- Response links will use the new format - Services that return self-referential links (such as Catalog and Batch APIs) will return URLs using the new path structure
- No breaking changes - All existing integrations will continue to function normally
Action required
None at this time. We're rolling this out gradually starting Tuesday, March 17th. Please do not make any changes to your integrations at this time. Both the old and new URL formats will be supported.
We're announcing this change in advance for transparency and to answer any questions you may have.
Questions?
If you have questions about this change, please reach out to our support team or post in the Planet Community forum.
