API docs by Redocly

Remedio Customer API (1.0)

Download OpenAPI specification:

Remedio customer API

Misconfigurations

Get All Remediable Misconfigurations

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.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit

cursor
string
Example: cursor=""

Cursor

Request Body schema: application/json

Request

object (filter.MisconFilterBody)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "nextCursor": "string"
}

List Affected Device

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.

Authorizations:
ApiKeyAuth
query Parameters
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 Body schema: application/json

Request

object (filter.DeviceFilterBody)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "desc": "string",
  • "filter": {
    },
  • "instanceValueCategory": "string",
  • "misconfigurationId": "string",
  • "nextCursor": "string",
  • "severity": "string",
  • "title": "string"
}

List Misconfiguration Instances

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.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit

cursor
string
Example: cursor=""

Cursor

misconfigurationId
required
string
Example: misconfigurationId="exampleMisconfigurationId"

Misconfiguration ID

Request Body schema: application/json

Request

object (filter.DeviceFilterBody)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "instanceValueCategory": "string",
  • "nextCursor": "string"
}

Filters

Get Available Filters

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.

Authorizations:
ApiKeyAuth
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "nextCursor": "string"
}

Actions

Add Labels to Devices

Schedule an action to add labels to selected devices. Labels must be 2-31 characters long and contain only alphanumeric characters, hyphens, and underscores. Supported since version 2.30.0

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request

object (filter.DeviceFilterBody)
labels
Array of strings

list of labels

remark
string

User-provided comment or note about the action

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "labels": [
    ],
  • "remark": "string"
}

Response samples

Content type
application/json
{
  • "actionId": 0
}

Get Action Log

Retrieves the Log of a action.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit

cursor
string
Example: cursor=""

Cursor

actionId
required
integer
Example: actionId=2000

Action ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "nextCursor": "string"
}

Remove Labels from Devices

Schedule an action to remove labels from selected devices. Labels must be 2-31 characters long and contain only alphanumeric characters, hyphens, and underscores. Supported since version 2.30.0

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request

object (filter.DeviceFilterBody)
labels
Array of strings

list of labels

remark
string

User-provided comment or note about the action

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "labels": [
    ],
  • "remark": "string"
}

Response samples

Content type
application/json
{
  • "actionId": 0
}

Schedule a Remediation Action

Schedules an immediate or future remediation action to fix the misconfiguration on selected devices. Used in: Final step when the user decides to remediate.

Authorizations:
ApiKeyAuth
query Parameters
misconfigurationId
required
string
Example: misconfigurationId="exampleMisconfigurationId"

Misconfiguration ID

instanceId
string
Example: instanceId="exampleInstanceId"

Instance ID

Request Body schema: application/json

Request

actionDatum
string

Optional: If provided use this as the remediation action to use

object (filter.DeviceFilterBody)
remark
string

User-provided comment or note about the action

Responses

Request samples

Content type
application/json
{
  • "actionDatum": "string",
  • "filter": {
    },
  • "remark": "string"
}

Response samples

Content type
application/json
{
  • "actionId": 0
}

Check Action Status

Retrieves the current status of an action, including how many devices succeeded, failed, or are pending. Used in: After scheduling, used to monitor progress.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit

cursor
string
Example: cursor=""

Cursor

actionId
required
integer
Example: actionId=2000

Action ID

Responses

Response samples

Content type
application/json
{
  • "actionDatum": "string",
  • "actionId": 0,
  • "actionProgress": {
    },
  • "actionType": "string",
  • "afterTime": 0,
  • "applyScheme": "string",
  • "data": [
    ],
  • "devices": 0,
  • "nextCursor": "string",
  • "remark": "string",
  • "state": "string",
  • "timezone": 0,
  • "weekDay": "string",
  • "window": 0
}

Get Actions

Retrieves the list of actions which were created or changed in the last 3 months.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit

cursor
string
Example: cursor=""

Cursor

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "nextCursor": "string"
}

Get Sensor Download Links

Allows you to get a list of all sensor types download links.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Groups

Create a new custom group

Creates a new group

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request

groupDescription
string
groupName
string

Responses

Request samples

Content type
application/json
{
  • "groupDescription": "string",
  • "groupName": "string"
}

Response samples

Content type
application/json
{
  • "groupId": 0
}

Preview group criteria devices

Previews the devices that would be affected by the group criteria devices

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limit

cursor
string

Cursor

Request Body schema: application/json

Criteria

object (groups.GroupCriteria)

Responses

Request samples

Content type
application/json
{
  • "criteria": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "isCriteriaExclude": true,
  • "nextCursor": "string"
}

List Criterias for a Group

Returns all criterias for an active group

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limit

cursor
string

Cursor

groupId
required
integer

Group ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "groupDescription": "string",
  • "groupId": 0,
  • "groupName": "string",
  • "groupType": "string",
  • "lastRefreshedAt": "string",
  • "nextCursor": "string"
}

Add group criteria

Adds multiple group criteria for a specific group

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request

Array of objects (groups.GroupCriteria)

number of allowed criterias in batch is limited to 10

groupId
integer

groupId of the group to add criteria to

Responses

Request samples

Content type
application/json
{
  • "criterias": [
    ],
  • "groupId": 0
}

Response samples

Content type
application/json
{
  • "criterias": [
    ]
}

Delete group criteria

Deletes multiple group criteria for a specific group

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request

criteriaIds
Array of integers
groupId
integer

Responses

Request samples

Content type
application/json
{
  • "criteriaIds": [
    ],
  • "groupId": 0
}

Response samples

Content type
application/json
{ }

Delete a Custom group

Deletes a group

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request

groupId
integer

Responses

Request samples

Content type
application/json
{
  • "groupId": 0
}

Response samples

Content type
application/json
{ }

List Devices in a Group

Returns all devices in a group

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limit

cursor
string

Cursor

groupId
required
integer

Group ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "groupDescription": "string",
  • "groupId": 0,
  • "groupName": "string",
  • "groupType": "string",
  • "lastRefreshedAt": "string",
  • "nextCursor": "string"
}

Edit a group

Updates the name and description of an existing group

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request

groupDescription
string
groupId
integer
groupName
string

Responses

Request samples

Content type
application/json
{
  • "groupDescription": "string",
  • "groupId": 0,
  • "groupName": "string"
}

Response samples

Content type
application/json
{ }

List Log for a Custom Group

Returns all log for a custom group

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limit

cursor
string

Cursor

groupId
required
integer

Group ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "groupDescription": "string",
  • "groupId": 0,
  • "groupName": "string",
  • "groupType": "string",
  • "lastRefreshedAt": "string",
  • "nextCursor": "string"
}

List Groups

Returns all groups

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limit

cursor
string

Cursor

type
required
string

For specific type of groups - possible values: custom, builtin, when not specified returns all groups

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "nextCursor": "string"
}

CIS

Retrieve aggregated CIS Control data

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. Supported since version 2.30.0

Authorizations:
ApiKeyAuth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "cisControlsVersion": "string",
  • "filter": {
    },
  • "includeMuted": true,
  • "includeZeroAlerts": true
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Devices

Get Device List

Fetch detailed information for devices. Used to list devices that match given conditions - e.g., “All Windows devices with sensors that haven’t reported in 14 days.”

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit

cursor
string
Example: cursor=""

Cursor

Request Body schema: application/json

Request

object (filter.DeviceFilterBody)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "nextCursor": "string"
}

Get Device Summary

Get summary statistics for devices matching the filter criteria. Returns counts for total, active, inactive, and decommissioned devices.

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request

object (filter.DeviceFilterBody)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "active": 0,
  • "decommissioned": 0,
  • "inactive": 0,
  • "total": 0
}
API docs by Redocly
 

GYTPOL Customer API (1.0)

Download OpenAPI specification:

 

GYTPOL customer API

 Misconfigurations

 Get All Remediable Misconfigurations

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.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit
cursor
string

Cursor
Request Body schema: application/json

Request

object (filter.FilterBody)
 

Responses

OK

Bad Request

Internal Server Error

Request samples

Content type
application/json
Copy
{
  • "filter": {
    }
}

Response samples

Content type
application/json
Copy
{
  • "data": [
    ],
  • "nextCursor": "string"
}
 
 

 List Affected Device

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.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit
cursor
string

Cursor
misconfigurationId
required
string
Example: misconfigurationId=exampleMisconfigurationId

Misconfiguration ID
instanceId
string
Example: instanceId=exampleInstanceId

Instance ID
Request Body schema: application/json

Request

object (filter.DeviceFilterBody)
 

Responses

OK

Bad Request

Internal Server Error

Request samples

Content type
application/json
Copy
{
  • "filter": {
    }
}

Response samples

Content type
application/json
Copy
{
  • "data": [
    ],
  • "desc": "string",
  • "filter": {
    },
  • "instanceValueCategory": "string",
  • "misconfigurationId": "string",
  • "nextCursor": "string",
  • "severity": "string",
  • "title": "string"
}
 
 

 List Misconfiguration Instances

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.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit
cursor
string

Cursor
misconfigurationId
required
string
Example: misconfigurationId=exampleMisconfigurationId

Misconfiguration ID
Request Body schema: application/json

Request

object (filter.DeviceFilterBody)
 

Responses

OK

Bad Request

Internal Server Error

Request samples

Content type
application/json
Copy
{
  • "filter": {
    }
}

Response samples

Content type
application/json
Copy
{
  • "data": [
    ],
  • "instanceValueCategory": "string",
  • "nextCursor": "string"
}
 
 

 Filters

 Get Available Filters

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.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit
cursor
string

Cursor
type
required
string
Enum: "group" "os" "ou" "domain" "device" "version" "ip" "label"

Filter type

Responses

OK

Bad Request

Internal Server Error

Response samples

Content type
application/json
Copy
{
  • "data": [
    ],
  • "nextCursor": "string"
}
 
 

 Actions

 Get Action Log

Retrieves the Log of a action.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit
cursor
string

Cursor
actionId
required
integer
Example: actionId=2000

Action ID

Responses

OK

Bad Request

Internal Server Error

Response samples

Content type
application/json
Copy
{
  • "data": [
    ],
  • "nextCursor": "string"
}
 
 

 Schedule a Remediation Action

Schedules an immediate or future remediation action to fix the misconfiguration on selected devices. Used in: Final step when the user decides to remediate.

Authorizations:
ApiKeyAuth
query Parameters
misconfigurationId
required
string
Example: misconfigurationId=exampleMisconfigurationId

Misconfiguration ID
instanceId
string
Example: instanceId=exampleInstanceId

Instance ID
Request Body schema: application/json

Request

object (filter.DeviceFilterBody)
 
remark
string

User-provided comment or note about the action

Responses

OK

Bad Request

Internal Server Error

Request samples

Content type
application/json
Copy
{
  • "filter": {
    },
  • "remark": "string"
}

Response samples

Content type
application/json
Copy
{
  • "actionId": 0
}
 
 

 Check Action Status

Retrieves the current status of an action, including how many devices succeeded, failed, or are pending. Used in: After scheduling, used to monitor progress.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit
cursor
string

Cursor
actionId
required
integer
Example: actionId=2000

Action ID

Responses

OK

Bad Request

Internal Server Error

Response samples

Content type
application/json
Copy
{
  • "actionDatum": "string",
  • "actionId": 0,
  • "actionProgress": {
    },
  • "actionType": "string",
  • "afterTime": 0,
  • "applyScheme": "string",
  • "data": [
    ],
  • "devices": 0,
  • "nextCursor": "string",
  • "remark": "string",
  • "state": "string",
  • "timezone": 0,
  • "weekDay": "string",
  • "window": 0
}
 
 

 Get Actions

Retrieves the list of actions which were created or changed in the last 3 months.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer
Example: limit=1000

Limit
cursor
string

Cursor

Responses

OK

Bad Request

Internal Server Error

Response samples

Content type
application/json
Copy
{
  • "data": [
    ],
  • "nextCursor": "string"
}
 
 

 Get Sensor Download Links

Allows you to get a list of all sensor types download links.

Authorizations:
ApiKeyAuth

Responses

OK

Bad Request

Internal Server Error

Response samples

Content type
application/json
Copy
{
  • "data": [
    ]
}