Agent Pools

The Agent Pools API provides operation to manage the update settings of the agents for your organization.

List all agent pools
OAuth 2.0: okta.agentPools.read

Lists all agent pools with pagination support

Request
query Parameters
limitPerPoolType
integer
Default: 5

Maximum number of AgentPools being returned

poolType
string (AgentType)

Agent type to search for

Enum: "AD" "IWA" "LDAP" "MFA" "OPP" "RUM" "Radius"
after
string

The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination.

Responses
200

OK

403

Forbidden

429

Too Many Requests

get/api/v1/agentPools
Request samples 
Response samples 
application/json
[
  • {
    • "agents": [
      ],
    • "id": "string",
    • "name": "string",
    • "operationalStatus": "DEGRADED",
    • "type": "AD"
    }
]
List all agent pool updates
OAuth 2.0: okta.agentPools.read
Lists all agent pool updates


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
query Parameters
scheduled
boolean
Scope the list only to scheduled or ad-hoc updates. If the parameter is not provided we will return the whole list of updates.


 
Responses 
200
OK


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/agentPools/{poolId}/updates
Request samples 
Response samples 
application/json
[
  • {
    • "agents": [
      ],
    • "agentType": "AD",
    • "enabled": true,
    • "id": "string",
    • "name": "string",
    • "notifyAdmin": true,
    • "reason": "string",
    • "schedule": {
      },
    • "sortOrder": 0,
    • "status": "Cancelled",
    • "targetVersion": "string",
    • "_links": {
      }
    }
]
Create an agent pool update
OAuth 2.0: okta.agentPools.manage
Creates an Agent pool update \n For user flow 2 manual update, starts the update immediately. \n For user flow 3, schedules the update based on the configured update window and delay.


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
Request Body schema: application/json
required
Array of objects (Agent) 
 
 Array 
isHidden
boolean
 
isLatestGAedVersion
boolean
 
lastConnection
string <date-time> 
 
name
string
 
operationalStatus
string (OperationalStatus) 
Operational status of a given agent


 Enum: "DEGRADED" "DISRUPTED" "INACTIVE" "OPERATIONAL"  
poolId
string
 
type
string (AgentType) 
Agent types that are being monitored


 Enum: "AD" "IWA" "LDAP" "MFA" "OPP" "RUM" "Radius"  
updateMessage
string
 
updateStatus
string (AgentUpdateInstanceStatus) 
Status for one agent regarding the status to auto-update that agent


 Enum: "Cancelled" "Failed" "InProgress" "PendingCompletion" "Scheduled" "Success"  
version
string
 
agentType
string (AgentType) 
Agent types that are being monitored


 Enum: "AD" "IWA" "LDAP" "MFA" "OPP" "RUM" "Radius"  
enabled
boolean
 
name
string
 
notifyAdmin
boolean
 
reason
string
 
object (AutoUpdateSchedule) 
The schedule of auto-update configured by admin.


 
cron
string
 
delay
integer
delay in days


 
duration
integer
duration in minutes


 
lastUpdated
string <date-time> 
last time when the updated finished (success or failed, exclude cancelled), null if job haven't finished once yet.


 
timezone
string
 
sortOrder
integer
 
status
string (AgentUpdateJobStatus) 
Overall state for the auto-update job from admin perspective


 Enum: "Cancelled" "Failed" "InProgress" "Paused" "Scheduled" "Success"  
targetVersion
string
 
Responses 
201
Created


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/agentPools/{poolId}/updates
Request samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string"
}
Response samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string",
  • "_links": {
    • "self": {
      }
    }
}
Retrieve an agent pool update's settings
OAuth 2.0: okta.agentPools.read
Retrieves the current state of the agent pool update instance settings


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
Responses 
200
OK


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/agentPools/{poolId}/updates/settings
Request samples 
Response samples 
application/json
{
  • "agentType": "AD",
  • "continueOnError": true,
  • "latestVersion": "string",
  • "minimalSupportedVersion": "string",
  • "poolId": "string",
  • "poolName": "string",
  • "releaseChannel": "BETA"
}
Update an agent pool update settings
OAuth 2.0: okta.agentPools.manage
Updates an agent pool update settings


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
Request Body schema: application/json
required
agentType
string (AgentType) 
Agent types that are being monitored


 Enum: "AD" "IWA" "LDAP" "MFA" "OPP" "RUM" "Radius"  
continueOnError
boolean
 
latestVersion
string
 
minimalSupportedVersion
string
 
poolName
string
 
releaseChannel
string (ReleaseChannel) 
Release channel for auto-update


 Enum: "BETA" "EA" "GA" "TEST"  
Responses 
201
Updated


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/agentPools/{poolId}/updates/settings
Request samples 
application/json
{
  • "agentType": "AD",
  • "continueOnError": true,
  • "latestVersion": "string",
  • "minimalSupportedVersion": "string",
  • "poolName": "string",
  • "releaseChannel": "BETA"
}
Response samples 
application/json
{
  • "agentType": "AD",
  • "continueOnError": true,
  • "latestVersion": "string",
  • "minimalSupportedVersion": "string",
  • "poolId": "string",
  • "poolName": "string",
  • "releaseChannel": "BETA"
}
Retrieve an agent pool update by ID
OAuth 2.0: okta.agentPools.read
Retrieves Agent pool update from updateId


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
updateId
required
string
Id of the update


 
Responses 
200
OK


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/agentPools/{poolId}/updates/{updateId}
Request samples 
Response samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string",
  • "_links": {
    • "self": {
      }
    }
}
Update an agent pool update by ID
OAuth 2.0: okta.agentPools.manage
Updates Agent pool update and return latest agent pool update


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
updateId
required
string
Id of the update


 
Request Body schema: application/json
required
Array of objects (Agent) 
 
 Array 
isHidden
boolean
 
isLatestGAedVersion
boolean
 
lastConnection
string <date-time> 
 
name
string
 
operationalStatus
string (OperationalStatus) 
Operational status of a given agent


 Enum: "DEGRADED" "DISRUPTED" "INACTIVE" "OPERATIONAL"  
poolId
string
 
type
string (AgentType) 
Agent types that are being monitored


 Enum: "AD" "IWA" "LDAP" "MFA" "OPP" "RUM" "Radius"  
updateMessage
string
 
updateStatus
string (AgentUpdateInstanceStatus) 
Status for one agent regarding the status to auto-update that agent


 Enum: "Cancelled" "Failed" "InProgress" "PendingCompletion" "Scheduled" "Success"  
version
string
 
agentType
string (AgentType) 
Agent types that are being monitored


 Enum: "AD" "IWA" "LDAP" "MFA" "OPP" "RUM" "Radius"  
enabled
boolean
 
name
string
 
notifyAdmin
boolean
 
reason
string
 
object (AutoUpdateSchedule) 
The schedule of auto-update configured by admin.


 
cron
string
 
delay
integer
delay in days


 
duration
integer
duration in minutes


 
lastUpdated
string <date-time> 
last time when the updated finished (success or failed, exclude cancelled), null if job haven't finished once yet.


 
timezone
string
 
sortOrder
integer
 
status
string (AgentUpdateJobStatus) 
Overall state for the auto-update job from admin perspective


 Enum: "Cancelled" "Failed" "InProgress" "Paused" "Scheduled" "Success"  
targetVersion
string
 
Responses 
201
Updated


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/agentPools/{poolId}/updates/{updateId}
Request samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string"
}
Response samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string",
  • "_links": {
    • "self": {
      }
    }
}
Delete an agent pool update
OAuth 2.0: okta.agentPools.manage
Deletes Agent pool update


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
updateId
required
string
Id of the update


 
Responses 
204
Deleted


403
Forbidden


404
Not Found


429
Too Many Requests


delete/api/v1/agentPools/{poolId}/updates/{updateId}
Request samples 
Response samples 
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}
Activate an agent pool update
OAuth 2.0: okta.agentPools.manage
Activates scheduled Agent pool update


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
updateId
required
string
Id of the update


 
Responses 
201
Activated


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/agentPools/{poolId}/updates/{updateId}/activate
Request samples 
Response samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string",
  • "_links": {
    • "self": {
      }
    }
}
Deactivate an agent pool update
OAuth 2.0: okta.agentPools.manage
Deactivates scheduled Agent pool update


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
updateId
required
string
Id of the update


 
Responses 
201
Deactivated


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/agentPools/{poolId}/updates/{updateId}/deactivate
Request samples 
Response samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string",
  • "_links": {
    • "self": {
      }
    }
}
Pause an agent pool update
OAuth 2.0: okta.agentPools.manage
Pauses running or queued Agent pool update


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
updateId
required
string
Id of the update


 
Responses 
201
Paused


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/agentPools/{poolId}/updates/{updateId}/pause
Request samples 
Response samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string",
  • "_links": {
    • "self": {
      }
    }
}
Resume an agent pool update
OAuth 2.0: okta.agentPools.manage
Resumes running or queued Agent pool update


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
updateId
required
string
Id of the update


 
Responses 
201
Resumed


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/agentPools/{poolId}/updates/{updateId}/resume
Request samples 
Response samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string",
  • "_links": {
    • "self": {
      }
    }
}
Retry an agent pool update
OAuth 2.0: okta.agentPools.manage
Retries Agent pool update


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
updateId
required
string
Id of the update


 
Responses 
201
Retried


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/agentPools/{poolId}/updates/{updateId}/retry
Request samples 
Response samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string",
  • "_links": {
    • "self": {
      }
    }
}
Stop an agent pool update
OAuth 2.0: okta.agentPools.manage
Stops Agent pool update


Request 
path Parameters
poolId
required
string
Id of the agent pool for which the settings will apply


 
updateId
required
string
Id of the update


 
Responses 
201
Stopped


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/agentPools/{poolId}/updates/{updateId}/stop
Request samples 
Response samples 
application/json
{
  • "agents": [
    • {
      }
    ],
  • "agentType": "AD",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "notifyAdmin": true,
  • "reason": "string",
  • "schedule": {
    • "cron": "string",
    • "delay": 0,
    • "duration": 0,
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "timezone": "string"
    },
  • "sortOrder": 0,
  • "status": "Cancelled",
  • "targetVersion": "string",
  • "_links": {
    • "self": {
      }
    }
}