Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.onetsolutions.net/llms.txt

Use this file to discover all available pages before exploring further.

API keys allow you to access OnetSolutions services programmatically. Use them to automate tasks, integrate with CI/CD pipelines, or build custom applications.
Prerequisites
  • An OnetSolutions account with an organization

​
Creating an API Key

1

Navigate to API Keys

Go to Settings > API Keys in your dashboard.
2

Click Create

Click the “Create API Key” button.
3

Configure the key

  • Name: Give your key a descriptive name (e.g., “CI/CD Pipeline”, “Monitoring Script”)
  • Expiration: Optionally set an expiration date
  • Scopes: Select the permissions for this key
4

Copy the key

After creation, copy the API key immediately. It will only be shown once.
Store your API key securely. Never share it publicly or commit it to version control.

​
Using API Keys

Include your API key in the Authorization header of your requests: 
curl -X GET "https://api.onetsolutions.net/v1/instances" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Managing API Keys

​
Viewing Keys

The API Keys page shows all your active keys with:
  • Key name
  • Creation date
  • Last used date
  • Expiration date (if set)

​
Revoking Keys

To revoke an API key:
  1. Go to Settings > API Keys
  2. Find the key you want to revoke
  3. Click the delete/revoke button
  4. Confirm the action
Revoking a key is immediate and permanent. Any applications using the key will lose access.

​
Project Tokens

For project-specific access, you can create tokens at Settings > Project > Tokens. These tokens are scoped to a specific project and have limited permissions.

​
Best Practices

Name your keys based on their purpose (e.g., “Production Deploy”, “Staging CI”) to easily identify them later.
For temporary needs, set an expiration date to automatically revoke the key.
Only grant the scopes your application needs, following the principle of least privilege.
Create new keys and revoke old ones periodically to limit potential exposure.
Never hardcode API keys in your application code. Use environment variables instead.

​
API Documentation

API Reference

Explore the full API documentation to see available endpoints and parameters.