Skip to main content

API Key Management

Updated today

Welcome to the Screenloop API documentation. This article will guide you on how to obtain and manage your API Keys from Screenloop's interface.

Who can manage an API keys? Admin only

For technical documentation on API usage, please view our Screenloop API documentation.

1. Creating an API Key

Once logged into your Screenloop account:

  1. Navigate to Settings > API Keys.

  2. Select Generate API Key in the top right.

  3. Fill the Key Name field with your chosen name.

  4. Click Generate.

  5. Copy the key to your clipboard.

This is the only time your API key will be visible. Copy it to your clipboard and store it in a secure location. You wonโ€™t be able to view it again.

2. Rename an existing API Key

  1. Navigate to Settings > API Keys.

  2. Select the ellipsis (...) for the key you wish to edit.

  3. Click Edit Key Name.

  4. Fill the Key Name field with the new name.

  5. Click Save.

3. Revoke and Re-enable an API Key

3.1 Revoking a Key

  1. Navigate to Settings > API Keys.

  2. Select the ellipsis (...) for the key you wish to edit.

  3. Click Revoke.

  4. Reconfirm by clicking Revoke in the modal.

3.2 Re-enabling a Key

  1. Navigate to Settings > API Keys.

  2. Click the Refresh Icon for the key you wish to re-enable.

  3. Confirm the action by clicking Re-enable in the modal.

Did this answer your question?