Developer API
The Joystick Developer API allows you to programmatically access and modify your a Product's configuration resources and settings, including any of the environments, webhooks, schemas, configs and more that are part of the Product. This enables powerful automation, workflows and integrations.
Getting Started
- Request access. Reach out to our team to enable Developer API access for your organization.
- Create a Product API Key.
- Use the Developer API!
Example Functionality
Many of the functions that you would normally have to go through the Joystick CMS to perform can now be accessed via API.
- Create a new Config.
- Update a Config.
- Sync config(s) between environments.
- Create push requests for configs between environments.
- Look at Configs across multiple environments.
Managing API Keys
A Product API key is required to use the Developer API. The Product API Key will only have access to all of the entities that belong to that Product within Joystick. Users must have the 'Editor' or 'Owner' permission on the Organization to manage Product API Keys.
Navigate to your Product view. Click "Product Settings" on the top right.
Click Manage Product API Keys
Access Levels
| Access Level | Description |
|---|---|
| Read Only | Access to most GET endpoints. |
| Basic Access | Can create, update, archive configs, sync configs, create push requests. No ability to modify, delete or archive other entities. |
| Full Access | Full control over all entities, including the ability to delete and archive. |
Need Help?
Please reach out to our team if you need help or require additional access.
Using the API
The Product API Key can be used with many of the management endpoints. It can be used to manage your Product, Environments, Configuration Content, Sync Configs, and much more.
Request
End Points
Please find the full list of endpoints here: https://capi.getjoystick.com/developer-api.Header
| Header | Value | Required | Notes |
|---|---|---|---|
x-product-api-key |
Your Product API Key | Yes | The API key created for the PRODUCT you are targeting. This is NOT the same API key that is used for configuration retrieval. |
Troubleshooting
Having issues? Please reach out to our team on Discord with any questions or requests.
Notes
API Usage and Security
- Product API Key requests count as 3x towards your API usage.
- Product API Keys pose risks, including the full deletion of your data. Please protect and use your Product API keys carefully.
- DO NOT create keys, especially Full Access keys, unless you are sure you need them.
- This feature is subject to change.