Browse Docs

Using Partner API

The DefensX Partner API provides comprehensive access to DefensX security platform functions for Partners and Managed Service Providers (MSPs).

This RESTful API enables partners to programmatically manage customers, monitor security events, configure policies, and access detailed analytics and reporting data.

Key Features

  • Customer Management: Create and manage customer accounts, users, and organizational settings

  • Security Monitoring: Access real-time logs for URL visits, credential protection, file transfers, and DNS queries

  • Policy Configuration: Create and manage security policies for web filtering, credential protection, and data loss prevention

  • Analytics & Reporting: Generate detailed statistics and cyber resilience assessments

  • Agent Management: Monitor and configure DefensX agents and deployments

  • Usage Tracking: Monitor subscription usage and billing information

Downloading YAML File

You can download the latest YAML file from the Partner Dashboard → API Keys page:

apikeys

After creating an API key, you can also explore the API using the Documentation button, which opens the embedded Swagger interface.

For more advanced testing scenarios, we recommend downloading the YAML file and importing it into tools such as Postman on your local computer.

Authentication

API access requires an API Key that must be obtained through the API Keys page.

  1. Obtain API Key: Navigate to the API Keys page

  2. Generate Token: Create a new API token for your integration

  3. Authorization: Include the API token in the Authorization header as a Bearer token:

Authorization: Bearer YOUR_API_TOKEN_HERE

Security & Access Control

  • IP Restrictions: For enhanced security, you can restrict API access to specific IP addresses while creating your API Keys

  • Rate Limiting: API requests are subject to rate limiting to ensure system stability

  • HTTPS Only: All API communications must use HTTPS encryption

Base URL

All API endpoints are relative to: https://cloud.defensx.com/api/partner/v1

Data Formats

  • Request/Response Format: JSON

  • Date Format: ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) or Unix timestamp

  • Character Encoding: UTF-8

  • Pagination: Most list endpoints support pagination with page and limit parameters