API keys let external tools, scripts, and AI assistants connect to BasicOps without using your password. They are useful for integrations, automations, reporting workflows, and MCP-based agent connections.
This guide explains how to create an API key in BasicOps, store it safely, and use it in your integration.
Before you start
Make sure you have:
- Access to a BasicOps account with permission to create API keys
- A clear purpose for the key, such as connecting an automation, internal app, reporting script, or agent.
- A secure place to store the key after it is created.
Treat API keys like passwords. Anyone with access to the key may be able to access BasicOps data allowed by that key.
This article contains:
- Step 1: Go to Settings
- Step 2: Select API Keys
- Step 3: Click add API Key
- Step 4: Add the key to your integration
- Step 5: Test the connection
- Troubleshooting
- Security Reminder
Step 1: Go to Settings
Step 2: Select API Keys
Step 3: Click add API Key
Give it a name, and an expiration.
If this key is for an Agent, select the agent that will receive permission for this key.
*If you do not see the option you don’t have the correct permissions. Ask your administrator to give the admin permissions.
After the key is created, copy it immediately and store it in a secure location such as:
- A secrets manager
- A password manager
- A protected environment variable
- A server-side secret store
Do not paste API keys into chat, email, task comments, or shared documents.
You will not be able to copy the key again. If you lose or forget your key just create a new key. Any previous keys remain active until revoked
Step 4: Add the key to your integration
Use the API key in the authorization header for requests to BasicOps.
A request uses a bearer token format:
Authorization: Bearer YOUR_API_KEYFor example, if your integration is calling the BasicOps API, configure the request headers to include the key before making API calls.
Step 5: Test the connection
Start with a safe read-only request, such as retrieving a list of projects, tasks, or workspace data that your account can access.
If the request succeeds, your key is working. If it fails, check:
- The key was copied correctly.
- The authorization header uses the correct format.
- The account has permission to access the requested data.
- The key has not been revoked or expired.
Troubleshooting
If your API key does not work, try these checks:
- Confirm there are no extra spaces before or after the key.
- Make sure the header says Authorization: Bearer YOUR_API_KEY.
- Verify that you are using the correct BasicOps API endpoint.
- Confirm your BasicOps user has access to the workspace, project, or task you are trying to reach.
- Create a new key if you suspect the original key was copied incorrectly or revoked.
Security Reminder
API keys are powerful. Create them intentionally, name them clearly, store them securely, rotate them regularly, and remove them when they are no longer needed.
A well-managed API key setup keeps your BasicOps integrations reliable while protecting your workspace data.
Article is closed for comments.