Redis on SAP BTP is a core in-memory cache service to support high-performance applications on SAP Business Technology Platform (BTP), keeping it reliable, secure, and performant.
One essential capability intended to help is the Pending Maintenance API, which allows developers and operators to programmatically detect and react to upcoming changes that could impact the service availability.
In this blog post, we’ll explore:
- What is the Pending Maintenance API
- Advantages of using the API
- Use cases
- How to use the API
What is the Pending Maintenance API?
The Pending Maintenance API is part of the Redis on SAP BTP extension reference APIs . It provides a programmatic interface to check for upcoming maintenance activities, such as security patches, software upgrades, or infrastructure changes that may require a restart or temporary downtime.
This API is particularly useful for applications that need to:
- Avoid unexpected disruptions
- Gracefully drain connections or pause processing
- Schedule maintenance windows
🔗 Reference: SAP Help - Redis on SAP BTP - Pending Maintenance API
Advantages of using the API
Benefit
| Description |
Proactive management | Get early warnings about upcoming maintenance tasks. |
Better uptime | Coordinate workload transitions to reduce downtime or performance impact. |
Automation ready | Use with CI/CD or observability pipelines to automatically take actions. |
Operational transparency | Improves visibility into platform-level changes. |
Use Cases
- Automated failover preparation: before maintenance begins, use the API to detect scheduled updates and gracefully reroute traffic or enable a read-only mode for Redis.
- CI/CD and deployment guardrails: integrate the API check into your deployment pipeline to block releases during maintenance windows, avoiding instability.
- Monitoring & alerts: hook the API into observability setup or custom dashboards to trigger alerts when maintenance is approaching.
- Data sync: use the API to trigger data synchronization to a secondary cache service prior to instance restarts.
How to use the API
curl -X GET 'https://{base-url}/v1/redis-cache/instances/{id}/pending-maintenance' \
-H "Authorization: Bearer <your-access-token>" \
-H "Accept: application/json"
* Add authorization Bearer Token and replace {id} with the Redis instance ID.
Example of a response payload:
{"pending_maintenance": [{"version": "redis 6.x and onwards, "description": "Upgrades to improve the security, reliability, and operational performance on arm-based ElastiCache nodes."}]}
Conclusion
The Pending Maintenance API empowers developers and DevOps teams to build resilient, observant, and maintenance-aware applications. Use it proactively to guard against disruptions, align your automation workflows, and ensure your Redis workloads stay healthy--even during infrastructure updates.
Thanks for reading!
For more insights from the product team on Redis on SAP BTP, don't miss to read:
Regards,
Antonio
