> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Keys

> Create and manage API keys for programmatic access to the Blink platform.

In the API Keys settings page you can manage your personal API keys of the Blink platform. You can create, delete and edit your API keys.

<Frame>
  <img src="https://mintcdn.com/blinkops-2/3DkxNJEChq_fnsNV/img/AccountAdmin/api-key.png?fit=max&auto=format&n=3DkxNJEChq_fnsNV&q=85&s=f3de24ccbf09aff66788eb0773a48cb2" width="3446" height="2164" data-path="img/AccountAdmin/api-key.png" />
</Frame>

<Note>**NOTE**: There always has to be one API key available. The maximum number of API keys at any given time is `5`.</Note>

## Create API Key

<Steps>
  <Step>
    Select the **New API Key** button in the top-right corner
  </Step>

  <Step>
    Give your API key a name, description (optional) and choose when the API Key expires (after 30 days, 90 days or never ). Then click the create button in the bottom-right corner.

    <Frame>
      <img src="https://mintcdn.com/blinkops-2/3DkxNJEChq_fnsNV/img/AccountAdmin/add-api-key.png?fit=max&auto=format&n=3DkxNJEChq_fnsNV&q=85&s=072f23bb1c270acf3883ba9c44f598ce" width="3452" height="2174" data-path="img/AccountAdmin/add-api-key.png" />
    </Frame>
  </Step>

  <Step>
    It will be added to the table.

    | Parameter   | Description                                                                                              |
    | ----------- | -------------------------------------------------------------------------------------------------------- |
    | Name        | Name given to the API Key                                                                                |
    | Description | Description given to the API Key                                                                         |
    | Key         | The API key itself                                                                                       |
    | Created At  | The time you created the API key                                                                         |
    | Expires     | It will display: the day of expiration, never- if no expiry is set or expired- if expiration date passed |
    | Last used   | The last time you used the API key                                                                       |
  </Step>
</Steps>

<Accordion title="The Default API Key is a Legacy Feature">
  ## Generate a New API Key

  <Note>**Note**: This setting can only be used with the default API key which is now a legacy feature so will only appear in certain Tenants</Note>

  To generate a new API key, click the <Icon icon="square-ellipsis-vertical" iconType="solid" /> icon on the right-hand side of the default API key row, then select **Rotate**.

  A popup will appear asking you to confirm if you are sure you would like to rotate the API key. Select the confirm button

  <Frame>
    <img src="https://mintcdn.com/blinkops-2/KIQckRTQAje7zTwT/img/AccountAdmin/ApproveRotation.png?fit=max&auto=format&n=KIQckRTQAje7zTwT&q=85&s=e2d010bdf08f019df1af76b9a53938c1" width="493" height="452" data-path="img/AccountAdmin/ApproveRotation.png" />
  </Frame>
</Accordion>

***

## Edit API Key

If you want to make any changes to the API information, double click on the cell and make the desired changes. You can change the API key name or description.

<Frame>
  <img src="https://mintcdn.com/blinkops-2/yRkQ-wRlnQIXwr-A/img/AccountAdmin/edit-api-key.gif?s=cb45eefdd4ce2643d564badcb2aeb230" width="1152" height="648" data-path="img/AccountAdmin/edit-api-key.gif" />
</Frame>

***

## Delete API Key

If you want to delete an API Key, click on the <Icon icon="square-ellipsis-vertical" iconType="solid" /> icon on the right-hand side of the row and select the **delete** option.

<Frame>
  <img src="https://mintcdn.com/blinkops-2/yRkQ-wRlnQIXwr-A/img/AccountAdmin/delete-api-key.png?fit=max&auto=format&n=yRkQ-wRlnQIXwr-A&q=85&s=77795259e057508fc0a64ed33cbad77c" width="3584" height="1990" data-path="img/AccountAdmin/delete-api-key.png" />
</Frame>

***

## Using your Personal API Key in Workflows

<Steps>
  <Step>
    Click anywhere on the workflow within the Workflow pack.
  </Step>

  <Step>
    You will be redirected to the Workflow Editor.
  </Step>

  <Step>
    Click the <Icon icon="square-ellipsis-vertical" iconType="solid" /> icon in the top right-hand side corner.
  </Step>

  <Step>
    Choose the Settings option to access the Workflow settings.
  </Step>

  <Step>
    Go to the **Run Methods** section and select the **REST API** or **CLI** method.
  </Step>

  <Step>
    Under the command text field, select which **personal API key** from the dynamic dropdown menu.
  </Step>

  <Step>
    Upon selection, your **personal API key** will be added to the command, allowing you to proceed using the chosen run method for your chosen Workflow.

    <Frame>
      <img src="https://mintcdn.com/blinkops-2/yRkQ-wRlnQIXwr-A/img/AccountAdmin/automation-api-key.gif?s=77a075997532b4bf79b4173616788dcf" width="1152" height="648" data-path="img/AccountAdmin/automation-api-key.gif" />
    </Frame>
  </Step>
</Steps>