POST /api/v1/agentPools/{poolId}/updates
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.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
poolId |
String | Yes |
Id of the agent pool for which the settings will apply |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No | |
_links |
Object | No |
Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations. |
agents[] |
Array | No | |
agents[].id |
String | No | |
agents[]._links |
Object | No |
Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations. |
agents[].isHidden |
Boolean | No | |
agents[].lastConnection |
String | No | |
agents[].name |
String | No | |
agents[].poolId |
String | No | |
agents[].updateMessage |
String | No | |
agents[].isLatestGAedVersion |
Boolean | No | |
agents[].version |
String | No | |
agents[].type |
String | No |
Agent types that are being monitored Valid values:
|
agents[].operationalStatus |
String | No |
Operational status of a given agent Valid values:
|
agents[].updateStatus |
String | No |
Status for one agent regarding the status to auto-update that agent Valid values:
|
sortOrder |
Integer | No | |
name |
String | No | |
targetVersion |
String | No | |
agentType |
String | No |
Agent types that are being monitored Valid values:
|
notifyAdmin |
Boolean | No | |
enabled |
Boolean | No | |
schedule |
Object | No |
The schedule of auto-update configured by admin. |
schedule.timezone |
String | No | |
schedule.delay |
Integer | No |
delay in days |
schedule.cron |
String | No | |
schedule.duration |
Integer | No |
duration in minutes |
schedule.lastUpdated |
String | No |
last time when the updated finished (success or failed, exclude cancelled), null if job haven't finished once yet. |
status |
String | No |
Overall state for the auto-update job from admin perspective Valid values:
|
reason |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.