Skip to content

Activate an agent pool update

Request

OAuth 2.0 scope:
  • okta.agentPools.manage

Activates a scheduled agent pool update

Path
poolIdstringrequired

ID of the agent pool for which the settings apply to

updateIdstringrequired

ID of the update

curl -i -X POST \
  'https://subdomain.okta.com/api/v1/agentPools/{poolId}/updates/{updateId}/activate'

Responses

Activated

Bodyapplication/json
agentsArray of objects(Agent)
agentTypestring(AgentType)

Agent types that are being monitored

Enum:"AD""IWA""LDAP""MFA""OPP""OPS""RUM""Radius"
enabledboolean

Indicates if auto-update is enabled for the agent pool

idstringread-only

ID of the agent pool update

namestring

Name of the agent pool update

Example:"region1A.dc"
notifyAdminboolean

Indicates if the admin is notified about the update

reasonstring

Reason for the update

Example:"Update failed."
scheduleobject(AutoUpdateSchedule)

The schedule of auto-update configured by the admin

sortOrderinteger

Specifies the sort order

statusstring(AgentUpdateJobStatus)

Overall state for the auto-update job from the admin perspective

Enum:"Cancelled""Failed""InProgress""Paused""Scheduled""Success"
targetVersionstring

The agent version to update to

Example:"3.20.0"
Response
{ "agents": [ { … } ], "agentType": "AD", "enabled": true, "id": "string", "name": "region1A.dc", "notifyAdmin": true, "reason": "Update failed.", "schedule": { "cron": "0 8 ? * 6#3", "delay": 0, "duration": 120, "lastUpdated": "2019-08-24T14:15:22Z", "timezone": "America/New_York" }, "sortOrder": 0, "status": "Cancelled", "targetVersion": "3.20.0", "_links": { "self": { … } } }