Skip to main content

Authentication

To access the Incipulse API, you must authenticate your requests. We currently support API Key authentication, which provides a secure way to integrate your applications and scripts.

API Keys​

Your API key is a unique token that identifies your application and determines its permissions.

Generating an API Key​

  1. Log in to the Management Portal.
  2. Navigate to Settings > API Credentials.
  3. Click Create API Key.
  4. Assign a Name (e.g., "GitHub Actions CI") and a Role (Read-Only or Read-Write).
  5. Copy your key immediately. For security reasons, the key will not be shown again.

Using your API Key​

Include your API key in the X-API-KEY header for all requests:

X-API-KEY: your_api_key_here

Query Parameter (Read-Only Only)​

For simple GET requests, you can also pass the key as a query parameter.

[!CAUTION] Avoid using query parameters for sensitive or write operations, as URLs may be logged by intermediate proxies or servers.

GET /api/StatusPage?api_key=your_api_key_here

Security Best Practices​

  • Rotate regularly: Regenerate your API keys every 90 days.
  • Minimum privilege: Use the Read-Only role unless your integration specifically needs to create or modify resources.
  • Environment variables: Never hardcode your API key in your source code. Use environment variables or a secret management service.

Error Codes​

CodeReason
401 UnauthorizedMissing or invalid API key.
403 ForbiddenThe API key is valid, but doesn't have the necessary permissions for this action.