Platform Integrations API

The Platform Integrations API lets you access and use your NordStellar security data programmatically. This API helps you connect NordStellar's security monitoring features with your existing security tools, dashboards, or automated workflows.

Why Use the Platform Integrations API?

Security Integration Benefits

The Platform Integrations API helps you:

• Connect with SIEM/SOAR Platforms: Send NordStellar security events directly to security platforms like Splunk, Elasticsearch, Microsoft Sentinel, IBM QRadar, or LogRhythm for better threat monitoring and response.

• Build Custom Dashboards: Create your own visualizations and monitoring screens that combine NordStellar data with other security information.

• Automate Response Workflows: Set up automatic actions when specific security events are detected, making your response faster and more efficient.

• Combine Security Data: Bring together data from NordStellar and your other security tools to see a complete picture of your security status.

• Create Custom Reports: Get data automatically to make reports for managers, compliance needs, or internal security reviews.

Key Integration Scenarios

1. Real-time Alert Processing: Stream NordStellar security events to your SIEM platform for real-time correlation with other security data.

2. Automated Incident Response: Configure your SOAR platform to initiate response workflows when critical NordStellar events are detected, such as automatically resetting compromised credentials or isolating affected systems.

3. Executive Dashboards: Create high-level security overview dashboards that combine NordStellar threat intelligence with other security metrics.

4. Compliance Reporting: Automatically generate reports for regulatory compliance by extracting and formatting relevant NordStellar security data.

5. Cross-platform Correlation: Correlate NordStellar dark web findings or leaked data events with internal logs to identify potential security breaches or vulnerabilities with greater context.

Authentication

Generating an API Key

To use the Platform Integrations API, you need to generate an API key:

1. Log in to your NordStellar platform account.
2. Navigate to Settings (opens in a new tab)
3. Click on Platform Integrations API in the settings menu.
4. Click the Create API Key button.
5. Copy and securely store your generated API key.

Important: The API key will only be shown once. If you lose it, you'll need to generate a new one.

Using the API Key

Include your API key in all API requests as a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Available Endpoints

The Platform Integrations API provides access to:

• Events Data: Retrieve detailed information about various security events including data breaches, malware infections, dark web mentions, and more.
• Project Management: Access and manage your NordStellar projects.
• Event Management: Update event states (e.g., mark as resolved).

API Reference Documentation

For a complete, interactive reference of all available endpoints, parameters, and response formats, refer to our Swagger documentation:

Code Examples

For practical implementation examples in various programming languages, see our Code Examples page.