To manage your secrets more effectively, we've made a few updates to our API endpoints. Here’s what you need to know to keep your apps running smoothly.
Deprecated endpoints—what’s going out
The following endpoints are saying goodbye on December 31, 2024. Make sure to switch over to our new methods below to keep everything working as it should.
GET /apps/{app-slug}/secrets/{secret-name}/valuePUT /apps/{app-slug}/secrets/{secret-name}
Introducing new endpoints—what’s coming in
- Creating secrets just got easier: Use
POST /apps/{app-slug}/secretsto set up new secrets. - Smoother updates: Modify your secrets with
PATCH /apps/{app-slug}/secrets/{secret-name}. - Get the full picture: Our enhanced
GET/apps/{app-slug}/secrets/{secret-name}not only fetches secret details but is also backward compatible with the old value retrieval endpoint. For protected secrets, where you used to see a 404 error, the new endpoint will still respond with the details of the secret, and omit the value.
Your next steps for a smooth transition
- Switch from
GET /apps/{app-slug}/secrets/{secret-name}/valuetoGET /apps/{app-slug}/secrets/{secret-name}. - Replace
PUT /apps/{app-slug}/secrets/{secret-name}withPOST /apps/{app-slug}/secretsfor creating new secrets andPATCH /apps/{app-slug}/secrets/{secret-name}for updates.
Get started
Check out how these changes affect your apps by reviewing your integration with our API. Start by identifying any use of the deprecated endpoints and plan your switch to our new, shiny ones.
Need help or have questions? Drop by our developer forum or reach out to our support team. We’re here to help make sure your transition is as smooth as can be!
