Download OpenAPI specification:
Remedio customer API
Fetches the full list of currently active and remediable misconfigurations in the system. These represent security or configuration issues detected on client devices. Used in: The initial step to display what can be remediated.
| limit | integer Example: limit=1000 Limit |
| cursor | string Example: cursor="" Cursor |
Request
object (filter.MisconFilterBody) |
{- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string",
- "severity": "string"
}
}{- "data": [
- {
- "alertsCount": 0,
- "description": "string",
- "devicesCount": 0,
- "instanceValueCategory": "string",
- "instancesCount": 0,
- "misconfigurationId": "string",
- "scores": {
- "cvss": 0
}, - "severity": "string",
- "title": "string"
}
], - "nextCursor": "string"
}Fetches devices affected by a specific misconfiguration or its instance. May be optionally filtered by group, OU, label, domain, etc. Used in: To retrieve the specific devices that can be remediated.
| limit | integer Example: limit=1000 Limit |
| cursor | string Example: cursor="" Cursor |
| misconfigurationId required | string Example: misconfigurationId="exampleMisconfigurationId" Misconfiguration ID |
| instanceId | string Example: instanceId="exampleInstanceId" Instance ID |
Request
object (filter.DeviceFilterBody) |
{- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}
}{- "data": [
- {
- "device": "string",
- "deviceId": 0,
- "instanceId": "string",
- "ip": "string",
- "mac": "string",
- "os": "string"
}
], - "desc": "string",
- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}, - "instanceValueCategory": "string",
- "misconfigurationId": "string",
- "nextCursor": "string",
- "severity": "string",
- "title": "string"
}Returns all known instance values associated with a specific misconfiguration. For example, if a misconfiguration is "Adobe Reader Version", this will return the affected versions detected on devices. Used in: Second step to show the different context values the misconfiguration takes across devices.
| limit | integer Example: limit=1000 Limit |
| cursor | string Example: cursor="" Cursor |
| misconfigurationId required | string Example: misconfigurationId="exampleMisconfigurationId" Misconfiguration ID |
Request
object (filter.DeviceFilterBody) |
{- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}
}{- "data": [
- {
- "alertsCount": 0,
- "devicesCount": 0,
- "instanceId": "string"
}
], - "instanceValueCategory": "string",
- "nextCursor": "string"
}Returns the available filter options (OS, Group, OU, etc.) that can be used to scope down which devices should be considered when fetching applicable devices or scheduling actions. Used in: Optional, depending on whether the user selects a filtering strategy.
| limit | integer Example: limit=1000 Limit |
| cursor | string Example: cursor="" Cursor |
| type required | string Enum: "group" "os" "ou" "domain" "device" "version" "ip" "label" Filter type |
{- "data": [
- null
], - "nextCursor": "string"
}Schedule an action to add labels to selected devices. Labels must be 2-31 characters long and contain only alphanumeric characters, hyphens, and underscores.
Request
object (filter.DeviceFilterBody) | |
| labels | Array of strings list of labels |
| remark | string User-provided comment or note about the action |
{- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}, - "labels": [
- "string"
], - "remark": "string"
}{- "actionId": 0
}Retrieves the Log of a action.
| limit | integer Example: limit=1000 Limit |
| cursor | string Example: cursor="" Cursor |
| actionId required | integer Example: actionId=2000 Action ID |
{- "data": [
- {
- "byUser": {
- "DisplayName": "string",
- "Title": "string",
- "UserName": "string"
}, - "date": "string",
- "notes": "string",
- "operation": "string"
}
], - "nextCursor": "string"
}Schedule an action to remove labels from selected devices. Labels must be 2-31 characters long and contain only alphanumeric characters, hyphens, and underscores.
Request
object (filter.DeviceFilterBody) | |
| labels | Array of strings list of labels |
| remark | string User-provided comment or note about the action |
{- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}, - "labels": [
- "string"
], - "remark": "string"
}{- "actionId": 0
}Schedules an immediate or future remediation action to fix the misconfiguration on selected devices. Used in: Final step when the user decides to remediate.
| misconfigurationId required | string Example: misconfigurationId="exampleMisconfigurationId" Misconfiguration ID |
| instanceId | string Example: instanceId="exampleInstanceId" Instance ID |
Request
object (filter.DeviceFilterBody) | |
| remark | string User-provided comment or note about the action |
{- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}, - "remark": "string"
}{- "actionId": 0
}Retrieves the current status of an action, including how many devices succeeded, failed, or are pending. Used in: After scheduling, used to monitor progress.
| limit | integer Example: limit=1000 Limit |
| cursor | string Example: cursor="" Cursor |
| actionId required | integer Example: actionId=2000 Action ID |
{- "actionDatum": "string",
- "actionId": 0,
- "actionProgress": {
- "cancelled": 0,
- "failed": 0,
- "pending": 0,
- "revertCancelled": 0,
- "revertFailed": 0,
- "reverted": 0,
- "reverting": 0,
- "success": 0,
- "total": 0
}, - "actionType": "string",
- "afterTime": 0,
- "applyScheme": "string",
- "data": [
- {
- "device": "string",
- "deviceId": 0,
- "instanceId": "string",
- "state": "string"
}
], - "devices": 0,
- "nextCursor": "string",
- "remark": "string",
- "state": "string",
- "timezone": 0,
- "weekDay": "string",
- "window": 0
}Retrieves the list of actions which were created or changed in the last 3 months.
| limit | integer Example: limit=1000 Limit |
| cursor | string Example: cursor="" Cursor |
{- "data": [
- {
- "actionDatum": "string",
- "actionType": "string",
- "afterTime": 0,
- "applyScheme": "string",
- "devices": 0,
- "exclusionStart": 0,
- "exclusionWeekDay": "string",
- "exclusionWindow": 0,
- "expiration": "string",
- "id": 0,
- "lastChangedBy": "string",
- "latestChange": "string",
- "progress": {
- "cancelled": 0,
- "failed": 0,
- "pending": 0,
- "revertCancelled": 0,
- "revertFailed": 0,
- "reverted": 0,
- "reverting": 0,
- "success": 0,
- "total": 0
}, - "remark": "string",
- "state": "string",
- "timezone": 0,
- "weekDay": "string",
- "window": 0
}
], - "nextCursor": "string"
}Aggregates CIS alerts and compliance coverage at the Safeguard level (Version 8.0 by default) with compliance and maturity scores per safeguard. Each safeguard includes total alerts, applicable alerts, compliance percentage, and a maturity score (5 if compliance = 100%, otherwise 2). Safeguards without a computable score are omitted unless explicitly requested. A different version can be requested using the cisControlsVersion parameter. Empty safeguards are excluded unless includeZeroAlerts=true is provided. If no filters are applied, aggregation is performed across all alerts.
Request
| ciscontrolsVersion | string CIS Controls version, default is 8.0 |
object (filter.CISFilterBody) | |
| includeMuted | boolean Include muted alerts |
| includeZeroAlerts | boolean Include controls with zero alerts |
{- "ciscontrolsVersion": "string",
- "filter": {
- "cisBenchmark": "string",
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}, - "includeMuted": true,
- "includeZeroAlerts": true
}{- "data": [
- {
- "alertsBad": 0,
- "alertsTotal": 0,
- "cisVersion": "string",
- "compliance": 0,
- "maturity": 0,
- "safeGuard": "string"
}
]
}Download OpenAPI specification:
GYTPOL customer API
Fetches the full list of currently active and remediable misconfigurations in the system. These represent security or configuration issues detected on client devices. Used in: The initial step to display what can be remediated.
| limit | integer Limit |
| cursor | string Cursor |
Request
object (filter.FilterBody) |
{- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string",
- "severity": "string"
}
}{- "data": [
- {
- "alertsCount": 0,
- "description": "string",
- "devicesCount": 0,
- "instanceValueCategory": "string",
- "instancesCount": 0,
- "misconfigurationId": "string",
- "scores": {
- "cvss": 0
}, - "severity": "string",
- "title": "string"
}
], - "nextCursor": "string"
}Fetches devices affected by a specific misconfiguration or its instance. May be optionally filtered by group, OU, label, domain, etc. Used in: To retrieve the specific devices that can be remediated.
| misconfigurationId required | string Misconfiguration ID |
| instanceId | string Instance ID |
Request
object (filter.DeviceFilterBody) |
{- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}
}{- "data": [
- {
- "device": "string",
- "deviceId": 0,
- "instanceId": "string",
- "ip": "string",
- "mac": "string",
- "os": "string"
}
], - "desc": "string",
- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}, - "instanceValueCategory": "string",
- "misconfigurationId": "string",
- "nextCursor": "string",
- "severity": "string",
- "title": "string"
}Returns all known instance values associated with a specific misconfiguration. For example, if a misconfiguration is "Adobe Reader Version", this will return the affected versions detected on devices. Used in: Second step to show the different context values the misconfiguration takes across devices.
| limit | integer Limit |
| cursor | string Cursor |
| misconfigurationId required | string Misconfiguration ID |
Request
object (filter.DeviceFilterBody) |
{- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}
}{- "data": [
- {
- "alertsCount": 0,
- "devicesCount": 0,
- "instanceId": "string"
}
], - "instanceValueCategory": "string",
- "nextCursor": "string"
}Schedules an immediate or future remediation action to fix the misconfiguration on selected devices. Used in: Final step when the user decides to remediate.
| misconfigurationId required | string Misconfiguration ID |
| instanceId | string Instance ID |
Request
object (filter.DeviceFilterBody) | |
| remark | string User-provided comment or note about the action |
{- "filter": {
- "clientVer": "string",
- "device": "string",
- "domain": "string",
- "groupId": 0,
- "ip": "string",
- "label": "string",
- "os": "string",
- "ou": "string"
}, - "remark": "string"
}{- "actionId": 0
}Retrieves the current status of a remediation or revert action, including how many devices succeeded, failed, or are pending. Used in: After scheduling, used to monitor progress.
| limit | integer Limit |
| cursor | string Cursor |
| actionId required | integer Action ID |
{- "actionDatum": "string",
- "actionId": 0,
- "actionProgress": {
- "cancelled": 0,
- "failed": 0,
- "pending": 0,
- "revertCancelled": 0,
- "revertFailed": 0,
- "reverted": 0,
- "reverting": 0,
- "success": 0,
- "total": 0
}, - "actionType": "string",
- "afterTime": 0,
- "applyScheme": "string",
- "data": [
- {
- "device": "string",
- "deviceId": 0,
- "instanceId": "string",
- "state": "string"
}
], - "devices": 0,
- "nextCursor": "string",
- "remark": "string",
- "state": "string",
- "timezone": 0,
- "weekDay": "string",
- "window": 0
}Returns the available filter options (OS, Group, OU, etc.) that can be used to scope down which devices should be considered when fetching applicable devices or scheduling actions. Used in: Optional, depending on whether the user selects a filtering strategy.
| limit | integer Limit |
| cursor | string Cursor |
| type required | string Enum: "group" "os" "ou" "domain" "device" "version" "ip" "label" Filter type |
{- "data": [
- null
], - "nextCursor": "string"
}