Getting started

API Key Generation

API Key Generation

To access Blackwire's powerful API and integrate it into your applications, you will need a Team or Enterprise account and must generate an API key.

Generating API Keys

API keys allow secure, programmatic access to Blackwire's features.

This functionality is available for team and enterprise account holders.

  1. Log in to your Blackwire account.

  2. Navigate to the account menu by clicking on your profile picture or name in the top-right corner.

  3. Select "Personal Tokens" from the dropdown menu.

  4. In the Personal Access Tokens page:

    • You'll see a list of your existing tokens (if any).

    • Each token shows its description, type, expiration date, and creation date.

  5. To create a new API key:

    • Click the red "Generate Token" button in the top-right corner.

    • A new dialog will open where you can set the following:

      • Description: Give your token a meaningful name for easy identification.

      • Type: Select "Client Credentials" for API access.

      • Expiration: Choose when the token should expire, or select "Never" for no expiration.

  6. After setting the details, click "Generate" to create your new API key.

  7. Important: Copy and securely store the generated token immediately. For security reasons, you won't be able to view the full token again after closing this dialog.

  8. Your new token will appear in the list with the details you provided.

  9. To revoke a token:

    • Find the token in the list.

    • Click the three-dot menu (⋮) on the right side of the token's row.

    • Select "Revoke" from the dropdown menu.


Remember:

  • Keep your API keys secure and never share them publicly.

  • Regularly review and rotate your API keys for enhanced security.

  • If you suspect a key has been compromised, revoke it immediately and generate a new one.

For any issues with API key generation or usage, please contact your account administrator or Blackwire's support team.

Getting Started Guide

Authentication

© Copyright 2023. All rights reserved.