The authorization (Basic Auth) uses your account's username and an API key as the password. You can find your personal API key in “My Account” on the proVconnect console: https://your-domain.com/#/Options/MyAccount.
\nTo protect the API from abusive traffic while remaining transparent to legitimate clients, a token bucket rate limiting algorithm is applied per authenticated user and per endpoint.
\nEach client is allocated a bucket of 10 tokens that refills continuously at a rate of 1 token every 6 seconds (10 requests per 60-second window). Short bursts of consecutive requests are tolerated as long as tokens remain available.
Once the bucket is exhausted, the endpoint returns:
HTTP 429 Too Many Requests\nRetry-After: <seconds>\n\nThe Retry-After header indicates the exact number of seconds to wait before the next request will be accepted. This value is calculated in real time based on the current refill state of your bucket — it is not a fixed delay.
\nRate limits are enforced per user account, not per IP address. Clients sharing a network proxy or NAT gateway are therefore not penalised collectively.
\nIf this limitation causes issues for your integration, please contact us to discuss your use case.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23554899","collectionId":"e6312eb0-169d-487c-a376-5187e19ab3a4","publishedId":"2sBXViiW65","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-01-20T16:57:12.000Z"},"item":[{"name":"Monitoring","item":[{"name":"Get All Incidents","id":"fe355803-f8a5-438c-b1d9-8607b0d3030c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This endpoint retrieves a paginated list of all monitoring incidents from the system. It returns comprehensive details about each incident including timing, status, and associated monitoring information.
\n\n\n\n
GET {{baseUrl}}/api/v1/monitoring/incidents?page={page}&pageSize={pageSize}
page (integer, optional): The page number to retrieve (default: 1)
pageSize (integer, optional): The number of incidents per page (default: 10, max: 50)
Example:GET /api/v1/monitoring/incidents?page=2&pageSize=20
Returns a paginated object with the following structure:
\n{\n \"Page\":1,\n \"PageSize\":1,\n \"TotalCount\":42,\n \"Data\":[\n {\n \"Id\":1,\n \"Status\":\"Closed\",\n \"StartDate\":\"2025-02-10T11:13:19.6373879Z\",\n \"EndDate\":\"2025-02-10T11:13:54.1017921Z\",\n \"Ack\":true,\n \"Comment\":null,\n \"NumberAlerts\":1,\n \"ClosedBy\":\"System user GREGTR\",\n \"Duration\":\"00:00:35\",\n \"AgentId\":10,\n \"Hostname\":\"Alex-VM-Prox-83\",\n \"IpAddress\":\"192.168.1.104\",\n \"RuleName\":\"proc low\",\n \"AlertLevel\":\"Normal\"\n }\n ]\n}\n\nThis endpoint returns all incidents in the system, regardless of status.
\nIncidents are monitoring events that may contain multiple alerts.
\nThe Duration field shows the total time from incident start to end.
The ClosedBy field indicates whether the incident was closed manually by a user or automatically by the system.
Use the page and pageSize query parameters to control pagination.
The TotalCount field allows clients to calculate the total number of pages.
Retrieves a paginated list of all currently open monitoring incidents. This endpoint returns real-time incident data for active alerts that have not yet been resolved or closed.
\nMethod: GET
Endpoint: {{baseUrl}}/api/v1/monitoring/incidents/open
Query Parameters:
\npage (integer, optional): The page number to retrieve (default: 1)
pageSize (integer, optional): The number of incidents per page (default: 10, max: 50)
Example:GET /api/v1/monitoring/incidents/open?page=2&pageSize=20
Returns a paginated object with the following structure:
\n{\n \"Page\":1,\n \"PageSize\":10,\n \"TotalCount\":1,\n \"Data\":[\n {\n \"Id\":74,\n \"Status\":\"Open\",\n \"StartDate\":\"2026-01-20T16:23:41.8999685Z\",\n \"EndDate\":\"0001-01-01T00:00:00Z\",\n \"Ack\":false,\n \"Comment\":null,\n \"NumberAlerts\":1,\n \"ClosedBy\":null,\n \"Duration\":\"00:00:09\",\n \"AgentId\":10,\n \"Hostname\":\"Alex-VM-Prox-83\",\n \"IpAddress\":\"192.168.1.104\",\n \"RuleName\":\"proc low\",\n \"AlertLevel\":\"High\"\n }\n ]\n}\n\nThe Data array will be empty if there are no open incidents.
EndDate will show a default date value (0001-01-01T00:00:00Z) for incidents that are still open.
ClosedBy and Comment fields may be null for unacknowledged or uncommented incidents.
Alert levels help prioritize incident response based on severity.
\nUse the page and pageSize query parameters to control pagination.
The TotalCount field allows clients to calculate the total number of pages.
This endpoint retrieves a paginated list of all monitoring incidents that have not been acknowledged. It returns a list of incidents that require attention or review.
\nMethod: GET
Path: {{baseUrl}}/api/v1/monitoring/incidents/notacked
Query Parameters:
\npage (integer, optional): The page number to retrieve (default: 1)
pageSize (integer, optional): The number of incidents per page (default: 10, max: 50)
Example:GET /api/v1/monitoring/incidents/notacked?page=2&pageSize=20
The endpoint returns a paginated object with the following fields:
\n{\n \"Page\":1,\n \"PageSize\":10,\n \"TotalCount\":2,\n \"Data\":[\n {\n \"Id\":73,\n \"Status\":\"Closed\",\n \"StartDate\":\"2026-01-05T15:39:08.3188738Z\",\n \"EndDate\":\"2026-01-05T15:43:23.3342998Z\",\n \"Ack\":false,\n \"Comment\":null,\n \"NumberAlerts\":3,\n \"ClosedBy\":null,\n \"Duration\":\"00:04:15\",\n \"AgentId\":10,\n \"Hostname\":\"Alex-VM-Prox-83\",\n \"IpAddress\":\"192.168.1.104\",\n \"RuleName\":\"fdgdgfd\",\n \"AlertLevel\":\"Normal\"\n },\n {\n \"Id\":74,\n \"Status\":\"Open\",\n \"StartDate\":\"2026-01-20T16:23:41.8999685Z\",\n \"EndDate\":\"0001-01-01T00:00:00Z\",\n \"Ack\":false,\n \"Comment\":null,\n \"NumberAlerts\":2,\n \"ClosedBy\":null,\n \"Duration\":\"00:01:50\",\n \"AgentId\":10,\n \"Hostname\":\"Alex-VM-Prox-83\",\n \"IpAddress\":\"192.168.1.104\",\n \"RuleName\":\"proc low\",\n \"AlertLevel\":\"High\"\n }\n ]\n}\n\nThe Data array will be empty if there are no not acknowledged incidents.
EndDate will show a default date value (0001-01-01T00:00:00Z) for incidents that are still open.
ClosedBy and Comment fields may be null for unacknowledged or uncommented incidents.
Use the page and pageSize query parameters to control pagination.
The TotalCount field allows clients to calculate the total number of pages.
This endpoint retrieves compliance, showing what percentage of devices or systems meet the defined criteria.
\n\n\n\n
GET {{baseUrl}}/api/v1/compliance/templates
The endpoint returns an array of compliance objects. Each object contains:
\nId (integer): The unique identifier of the compliance template
\nName (string): The name of the compliance being measured
\nPercentage (number): The compliance percentage (0-100)
\n[\n {\n \"Id\":1,\n \"Name\":\"win 11 upgrade capable\",\n \"Percentage\":0\n },\n {\n \"Id\":2,\n \"Name\":\"ram\",\n \"Percentage\":71.43\n },\n {\n \"Id\":3,\n \"Name\":\"free space\",\n \"Percentage\":14.29\n }\n]\n\nThis endpoint retrieves compliance information for monitored devices. It returns the overall conformity percentage as well as the total number of compliant and non-compliant devices for the selected compliance template.
\nMethod: GET
URL: {{baseUrl}}/api/v1/compliance/templates/{{id}}
baseUrl - The base URL for the proVconnect API (configured in environment)
id - The unique identifier of your compliance template
The endpoint returns a JSON object with the following fields:
\n{\n \"Id\":2,\n \"Name\":\"ram\",\n \"Percentage\":71.43,\n \"Description\":\"\",\n \"NotCompliantDevices\":2,\n \"CompliantDevices\":5\n}\n\nIn this example:
\n71.43% of monitored devices meet the \"RAM\" compliance requirements
\n2 devices do not meet the requirements
\n5 devices meet the requirements
\nThis endpoint provides a summary view only; use the dedicated compliant and non-compliant devices endpoints to retrieve the device lists for remediation or investigation
\nThis endpoint retrieves the list of compliant devices for a given compliance template. It returns the overall conformity percentage, pagination information, and the paginated list of devices that meet the compliance requirements.
\nMethod: GET
URL: {{baseUrl}}/api/v1/compliance/templates/{{id}}/devices/compliant
baseUrl - The base URL for the proVconnect API
id - The unique identifier of your compliance template
page - The page number to retrieve (default: 1)
pageSize - The number of devices to return per page (maximum: 50)
The endpoint returns a JSON object with the following fields:
\nEach device object in the array contains:
\n{\n \"Id\":2,\n \"Name\":\"ram\",\n \"Percentage\":71.43,\n \"Description\":\"\",\n \"TotalCount\":5,\n \"Page\":1,\n \"PageSize\":2,\n \"CompliantDevices\":[\n {\n \"Id\":3,\n \"Hostname\":\"desktop-prod-01\",\n \"Ip\":\"192.168.1.10\"\n },\n {\n \"Id\":7,\n \"Hostname\":\"desktop-prod-02\",\n \"Ip\":\"192.168.1.11\"\n }\n ]\n}\n\nIn this example:
\n71.43% of monitored devices meet the \"RAM\" compliance requirements
\n5 devices are compliant for this compliance template
\nThis response returns page 1 with 2 devices
\nThe compliant devices can be identified by their ID, hostname, and IP address for reporting or verification
\nThis endpoint retrieves the list of non-compliant devices for a given compliance template. It returns the overall conformity percentage, pagination information, and the paginated list of devices that do not meet the compliance requirements.
\nMethod: GET
URL: {{baseUrl}}/api/v1/compliance/templates/{{id}}/devices/notcompliant
baseUrl - The base URL for the proVconnect API (configured in environment)
id - The unique identifier of your compliance template
page - The page number to retrieve (default: 1)
pageSize - The number of devices to return per page (maximum: 50)
The endpoint returns a JSON object with the following fields:
\nEach device object in the array contains:
\n{\n \"Id\":2,\n \"Name\":\"ram\",\n \"Percentage\":71.43,\n \"Description\":\"\",\n \"TotalCount\":2,\n \"Page\":1,\n \"PageSize\":2,\n \"NotCompliantDevices\":[\n {\n \"Id\":10,\n \"Hostname\":\"Alex-VM-Prox-83\",\n \"Ip\":\"192.168.1.104\"\n },\n {\n \"Id\":24,\n \"Hostname\":\"win7-test-alex\",\n \"Ip\":\"192.168.1.102\"\n }\n ]\n}\n\nIn this example:
\n71.43% of monitored devices meet the \"RAM\" compliance requirements
\n2 devices are non-compliant for this compliance template
\nThis response returns page 1 with 2 non-compliant devices
\nThe non-compliant devices can be identified by their ID, hostname, and IP address for remediation or investigation
\nThis endpoint retrieves a paginated list of all groups in the system along with their associated custom fields. It provides a view of the organizational structure, including parent-child relationships and the number of agents assigned to each group. Pagination allows clients to efficiently browse large datasets.
\nRequest Parameters
\nExample request:
\nGET /api/v1/groups/list?page=2&pageSize=10
The endpoint returns a paginated object with the following fields:
\nEach group object contains:
\nEach item in the CustomFields array contains:
FieldName: The name/key of the custom field
Value: The value assigned to this field (can be null if not set)
Groups are organized in a parent-child hierarchy using the ParentId field:
Root groups have ParentId: null
Child groups reference their parent via ParentId
Multiple levels of nesting are supported
\nMyCompany (ID: 2, ParentId: null)\n├── Europe (ID: 3, ParentId: 2)\n│ ├── France (ID: 5, ParentId: 3)\n│ │ └── Rennes 1 (ID: 7, ParentId: 5)\n│ │ ├── Caisses (ID: 9, ParentId: 7)\n│ │ ├── Telephones (ID: 10, ParentId: 7)\n│ │ └── Tablettes (ID: 11, ParentId: 7)\n│ └── Spain (ID: 6, ParentId: 3)\n└── US (ID: 4, ParentId: 2)\n\n{\n \"TotalCount\": 42,\n \"Page\": 2,\n \"PageSize\": 10,\n \"Data\": [\n {\n \"GroupId\": 5,\n \"GroupName\": \"France\",\n \"CustomFields\": [\n { \"FieldName\": \"Siret\", \"Value\": \"123456789\" },\n { \"FieldName\": \"MailSupport\", \"Value\": null }\n ],\n \"ParentId\": 3,\n \"AgentCount\": 12\n },\n // ... up to 10 group objects\n ]\n}\n\nOrganization Visualization: Build a tree view or hierarchical display of the entire organizational structure
\nGroup Management: Retrieve all groups for administrative purposes, including editing or reorganizing
\nAgent Distribution Analysis: Analyze how agents are distributed across different groups using the AgentCount field
Custom Field Reporting: Extract and report on custom field values across all groups (e.g., finding all groups with a specific Siret number)
\nHierarchy Navigation: Implement breadcrumb navigation or parent-child relationship displays in the UI
\nBulk Operations: Prepare data for bulk updates or migrations across multiple groups
\nCompliance Tracking: Monitor which groups have required custom fields populated (e.g., Mail support, Siret)
\nThe AgentCount represents the number of agents directly assigned to that specific group
Custom field values can be null if they haven't been set for a particular group
Groups with AgentCount: 0 may still be important for organizational structure even without direct agent assignments
Custom fields are consistent across all groups but may have different values or be unpopulated (null) for different groups
Retrieves a paginated list of agents (devices) that belong to a specific group. This endpoint returns comprehensive information about each agent, including hardware specifications, disk/partition details, and security configuration status.
\n\n\nGET /api/v1/devices/group/{groupId}?page={page}&pageSize={pageSize}
\n
groupId (integer, required): The unique identifier of the group.
\npage (integer, optional): The page number to retrieve (default: 1).
\npageSize (integer, optional): The number of agents per page (default: 50, max: 100).
\nExample:GET /api/v1/devices/group/11?page=2&pageSize=25
{\n \"TotalCount\":6,\n \"Page\":1,\n \"PageSize\":2,\n \"Data\":{\n \"GroupId\":5,\n \"GroupName\":\"Group A\",\n \"Agents\":[\n {\n \"Id\":1,\n \"AgentIdentifier\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"Hostname\":\"device-01\",\n \"Ip\":\"10.0.0.1\",\n \"LastInventory\":\"2026-03-09T17:06:23.1286859Z\",\n \"OS\":\"Windows 11 Pro\",\n \"Memory\":17179869184,\n \"Disks\":[\n {\n \"Name\":\"\\\\.\\\\PHYSICALDRIVE0\",\n \"Size\":1000202273280,\n \"Smart\":\"OK\"\n }\n ],\n \"Partitions\":[\n {\n \"Name\":\"C:\",\n \"FileSystem\":\"NTFS\",\n \"Size\":999261466624,\n \"FreeSpace\":209690431488,\n \"Encrypted\":\"Off\",\n \"VolumeName\":\"\"\n }\n ],\n \"Security\":{\n \"Firewall\":\"Unknown\",\n \"AutoUpdate\":\"Enabled\",\n \"Antivirus\":\"Unknown\",\n \"Antispyware\":\"Enabled\",\n \"InternetSettings\":\"Unknown\",\n \"UACControl\":\"Enabled\",\n \"WSCService\":\"Unknown\"\n }\n },\n {\n \"Id\":2,\n \"AgentIdentifier\":\"yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy\",\n \"Hostname\":\"device-02\",\n \"Ip\":\"10.0.0.2\",\n \"LastInventory\":\"2026-03-09T09:25:44.752336Z\",\n \"OS\":\"Windows 11 Pro\",\n \"Memory\":4294967296,\n \"Disks\":[\n {\n \"Name\":\"\\\\.\\\\PHYSICALDRIVE0\",\n \"Size\":53686402560,\n \"Smart\":\"OK\"\n }\n ],\n \"Partitions\":[\n {\n \"Name\":\"E:\",\n \"FileSystem\":\"NTFS\",\n \"Size\":156233728,\n \"FreeSpace\":129691648,\n \"Encrypted\":\"Off\",\n \"VolumeName\":\"Storage\"\n },\n {\n \"Name\":\"C:\",\n \"FileSystem\":\"NTFS\",\n \"Size\":52771680256,\n \"FreeSpace\":12676988928,\n \"Encrypted\":\"Off\",\n \"VolumeName\":\"\"\n }\n ],\n \"Security\":{\n \"Firewall\":\"Enabled\",\n \"AutoUpdate\":\"Enabled\",\n \"Antivirus\":\"Enabled\",\n \"Antispyware\":\"Enabled\",\n \"InternetSettings\":\"Enabled\",\n \"UACControl\":\"Enabled\",\n \"WSCService\":\"Enabled\"\n }\n }\n ]\n }\n}\n\nTotalCount: Total number of agents in the group.
\nPage: Current page number.
\nPageSize: Number of agents per page.
\nData: Object containing group and agents information.
\nGroupId: The unique identifier of the group.
\nGroupName: The display name of the group.
\nAgents: Array of agent/device objects for this page.
\nId: Unique agent identifier.
\nAgentIdentifier: UUID for the agent.
\nHostname: Computer hostname (anonymized).
\nIp: IP address of the device (anonymized).
\nLastInventory: ISO 8601 timestamp of last inventory update.
\nOS: Operating system name and edition.
\nMemory: Total RAM installed, in bytes (integer).
\nDisks: Array of physical disk objects.
\nPartitions: Array of logical partition/volume objects.
\nSecurity: Security configuration object.
\nName: Physical disk identifier.
\nSize: Total disk capacity, in bytes (integer).
\nSmart: S.M.A.R.T. health status (e.g., \"OK\").
\nName: Drive letter or mount point.
\nFileSystem: File system type (e.g., \"NTFS\").
\nSize: Total partition size, in bytes (integer).
\nFreeSpace: Available free space, in bytes (integer).
\nEncrypted: Encryption status as a string (\"Off\", \"On\", \"Unknown\", \"None\".).
\nVolumeName: Volume label.
\nFirewall: Firewall status (\"Enabled\"/\"Disabled\"/\"Unknown\").
\nAutoUpdate: Automatic updates status.
\nAntivirus: Antivirus protection status.
\nAntispyware: Antispyware protection status.
\nInternetSettings: Internet security settings status.
\nUACControl: User Account Control status.
\nWSCService: Windows Security Center service status.
\nNotes:
\nUse the page and pageSize query parameters to control pagination.
The TotalCount field allows clients to calculate the total number of pages.
The Agents array contains only the agents for the requested page.
All sizes and memory values are returned in bytes (integer).
\nThe Encrypted field is a string representing the encryption status (e.g., \"Off\", \"On\", \"Unknown\").