Skip to main content

โœ… Prerequisites

Ensure you meet these prerequisites before starting:
  • Active incident.io Account (Administrator privileges recommended)
  • Verified Email Address linked to your incident.io account
  • Permission to generate API keys (Usually Admin or Developer role)

๐Ÿ”‘ Generate an API Key in incident.io for API Authentication

To generate an API key in the incident.io UI for integrating with AirMDR, follow these steps:
1

Log in to incident.io

  1. Navigate to incident.io and sign in with your credentials.
2

Access API Key Settings

  1. Click on your profile avatar or initials in the top-right corner.
  2. From the dropdown menu, select Settings.
  3. In the Settings sidebar, click on API Keys.
    User must have account-level or team-scopedย Manage API keysย permission to complete this procedure.

    IncidentIO1 Pn
3

Create a new API Key

  1. Click the + Add new button in the top-right corner.
  2. Provide a descriptive name for the API key (e.g., AirMDRIntegration).
  3. Select the appropriate permissions scope for the API key.
    • Select account-level access for organization-wide visibility.
    • Select the required teams if access should be team-scoped.
  4. Click Create.
This is the only time the API Key will be displayed.
Copy and securely store the value in your preferred password manager or approved secure credential-management system.
Share the API key to AirMDR for setup
or
Self configure incident.io in the AirMDR Integrations Dashboard.

AirMDR authentication field

Skills Provided by this Integration

To view the details of Input Parameters and Output for the respective skills

Incident.io API Testing

Open cURL and run the following command to check if your API Key is working: Request
Response

Configure Incident.io in the AirMDR Integrations Dashboard

  1. Navigate to AirMDR, provide the credentials, and click Login
  2. Navigate to the AirMDR Integrations Dashboard in the left navigation pane and select ADMIN โ†’ Integrations
  3. Use the search option, enter the keyword โ€œIncident.ioโ€, select the Connections tab, and click + Add New Connection.
  4. Enter an unique name to the Instance (e.g., your org name-Incident.io) to easily identify the user connection by AirMDR and brief Description.
  5. Enter the generated API Key in the Authentication Details field params, and click Save.

Additional Information

Monitor the connection in AirMDR

Use the following locations to monitor the integration:
  1. Openย AirMDR โ†’ Integrations โ†’ Incident.io.
  2. Select theย Connectionsย tab.
  3. Review the connection status.
  4. Open the relevant AirMDR case or playbook execution.
  5. Review the Incident.io skill execution status, request outcome and error details.

Monitor the API key in Incident.io

  1. Openย Incident.io โ†’ Settings โ†’ API keys.
  2. Locate the API key created for AirMDR.
  3. Review its permissions and recent usage information.
  4. Confirm that the key has not been revoked or rotated without updating AirMDR.

Example successful log entry

Example permission-error log entry

Example rate-limit log entry

Security requirement:ย Never record the API key or fullย Authorizationย header in logs. Mask secrets before collecting or sharing troubleshooting information.

Do

  • Create a dedicated API key for the AirMDR integration.
  • Use a descriptive name such asย AirMDR Integration.
  • Use team-scoped access when organization-wide access is unnecessary.
  • Copy the token directly into the AirMDR connection form.
  • Rotate the API key according to your organizationโ€™s credential-rotation policy.
  • Review the API keyโ€™s permissions periodically.
  • Remove or revoke unused API keys.

Do not

  • Reuse a personal or unrelated integration API key.
  • Grant create, edit, or schedule-management permissions unless Engineering confirms they are required.
  • Send the API key through email, chat, or support tickets.
  • Store the API key in source code or documentation.
  • Include the API key in screenshots, logs, or troubleshooting evidence.
  • Paste the actual API key into example commands retained in shell history.
  • ๐Ÿ“ง Contact AirMDR Support through your designated support channel.
  • ๐Ÿ” Rotate credentials regularly. Recommended cadence:ย Every 90 days or as per internal security policy
Recommended maintenance schedule

Data exchanged

Depending on the skill, AirMDR can exchange the following information with Incident.io:Network requirementsThe integration uses outbound HTTPS requests. No inbound connection from Incident.io is required for the API-key-based read operations described in this guide.

Encryption

  • API traffic is transmitted over HTTPS using TLS.
  • Incident.io states that its platform encrypts data at rest using AES-256 and encrypts data in transit using TLS.ย Incident.io security architecture.
  • Do not record a specific AirMDR credential-storage algorithm in this guide unless it has been verified by the AirMDR Security or Engineering team.