---
title: "API Documentation & Access"
slug: "api-access"
updated: 2025-01-20T21:18:29Z
published: 2025-01-20T21:18:29Z
---

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

# API Documentation & Access

### Documentation

Nucleus has a comprehensive API that is fully documented using Swagger. API documentation can be accessed from within your Nucleus instance. Once logged, in open the API documentation by clicking the **View API Docs** button in the top right of the page header.

![](https://cdn.document360.io/3888970a-6501-459e-acc9-c47b71c6d64c/Images/Documentation/image(390).png)

### Access

#### Generating a User API Key

Users with [API Access](https://help.nucleussec.com/docs/users-roles-and-permissions#api) can create their own API key.

API Key Expiration

A user's API Key will remain valid unless they regenerate a new one or until the user is deleted/disabled.

Follow these steps to generate an API key for your user account:

1. Log into your Nucleus console.
2. In the top right of the screen, click on the **User** icon and then click **User Profile**.
3. If this is your first time using an API key, click **Generate API Key**.
4. Click the **Copy**icon to copy the API key to your clipboard.

#### Generating a Service Account API Key

Nucleus [organization administrators](https://help.nucleussec.com/docs/users-roles-and-permissions#organization-admin) can create service account API keys.

Follow these steps to create a service account and generate an API key:

1. Navigate to the **Global Dashboard** **> Global Administration > Users**.
2. In the top row, click **Add API Account**.
3. Enter an **API Account Username**. This account will only have API access.
4. **Select the project(s)** that the account will have access to.
5. For each project, assign the account a **Role** within it. See [Defining new roles](https://help.nucleussec.com/docs/users-roles-and-permissions#defining-new-roles) for creating a new role with different permissions.
6. Click **Create Account**.
7. Find the newly created account in the **Users** list, and under the **Actions** column click the icon **View API Key For Account.**
8. Click **Show API Key**.
9. Copy the API key and click **Close**.

#### Using the API Key

1. Navigate to the API documentation page by clicking the View API Docs button in the top right of the Nucleus console.

![view-api-docs.png](https://cdn.document360.io/3888970a-6501-459e-acc9-c47b71c6d64c/Images/Documentation/view-api-docs%281%29.png)

1. In a separate tab will open with the swagger-based Nucleus API documentation.
2. Click Authorize
3. Paste your API Key into the pop-up and click Save

You can now test all the calls in the Nucleus documentation by clicking on the Try it out button in each of the API sections.

![api-try-it-out-button.png](https://cdn.document360.io/3888970a-6501-459e-acc9-c47b71c6d64c/Images/Documentation/api-try-it-out-button.png)

If you have any questions, please contact us through the [support center](https://nucleussec.atlassian.net/servicedesk/customer/portal/3).