Generating API Keys

API keys provide a way to programmatically authenticate against the Cycle platform. Learn how to create them and manage their permissions.

Adding a new key

First, navigate to hub settings, and click API Keys from the top nav.

Then click Create API Key.

Name the key and describe capabilities

When creating an API Key on Cycle, capabilities of that key, similar to capabilities of a user, must be set.

See a full list of capabilities and their description here.

To create the API key enter a name and select the capabilities, then press Create API Key.

Confirm and Copy

After creating the API key, the key itself will be shown one time. Be sure to copy the full key by using the copy utility next to where the key is displayed.

Below the key, there will be a full list of the capabilities and a reminder of the capabilities that have been enabled on this key. If changes need to be made, simply click the boxes that need to be added or removed and click Update API Key.

Deleting API Keys

To delete a key simple enter the name in the form on the right hand side of the screen and press the Delete API Key button.

Need Help?

If you've got questions about the platform or need some help getting started, our team is more than happy to assist. Whether you're new to containers or just new to Cycle, reach out to us via livechat by clicking the blue circle in the bottom right corner. Join our Slack channel, and get help from the dev team or other members of the community, and check out our Roadmap to see what's planned for the future!