Skip to main content

Get an API Key

API keys are how you authenticate requests to Skywalk API. Each key is scoped to a project and can be configured with specific permissions.

Create an API Key​

From the Dashboard, navigate to your project, go to Settings and open the API Keys section. Click Create API Key and give it a descriptive name — for example, "Reporting Integration" or "AI Agent Read-Only".

Creating an API key lets you choose its scoped permissions.
Creating an API key lets you choose its scoped permissions.

Using Your API Key​

Include your API key in the X-API-Key header with every request:

curl https://api.skywalkapi.com/v1/properties \
  -H "X-API-Key: YOUR_API_KEY"

See Authentication for full details on the authentication header and example requests.

Key Permissions​

Each key can be configured with custom scopes to control access:

  • Read-only or read/write access — control whether the key can create or modify data
  • Endpoint restrictions — limit which API endpoints the key can access
tip

Create separate keys for different integrations. For example, use a read-only key for reporting dashboards and a separate key with write access for tools that need to create tenant charges. This way you can revoke access for one integration without affecting others.

Revoking a Key​

To revoke a key, go to the API Keys section and click Delete next to the key you want to disable. The key will stop working immediately.

Best Practices​

  • Never expose keys in frontend code or public repositories
  • Use scoped keys with the minimum permissions each integration needs
  • Use descriptive names so you can easily identify which integration uses which key
Endpoints & Data
View all available data types and endpoints.
AI Agents
How to use with AI Agents.