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": [
    ]
}