Okta.Sdk.Api.AgentPoolsApi

October 22, 2025 ยท View on GitHub

All URIs are relative to https://subdomain.okta.com

MethodHTTP requestDescription
ActivateAgentPoolsUpdatePOST /api/v1/agentPools/{poolId}/updates/{updateId}/activateActivate an agent pool update
CreateAgentPoolsUpdatePOST /api/v1/agentPools/{poolId}/updatesCreate an agent pool update
DeactivateAgentPoolsUpdatePOST /api/v1/agentPools/{poolId}/updates/{updateId}/deactivateDeactivate an agent pool update
DeleteAgentPoolsUpdateDELETE /api/v1/agentPools/{poolId}/updates/{updateId}Delete an agent pool update
GetAgentPoolsUpdateInstanceGET /api/v1/agentPools/{poolId}/updates/{updateId}Retrieve an agent pool update by ID
GetAgentPoolsUpdateSettingsGET /api/v1/agentPools/{poolId}/updates/settingsRetrieve an agent pool update's settings
ListAgentPoolsGET /api/v1/agentPoolsList all agent pools
ListAgentPoolsUpdatesGET /api/v1/agentPools/{poolId}/updatesList all agent pool updates
PauseAgentPoolsUpdatePOST /api/v1/agentPools/{poolId}/updates/{updateId}/pausePause an agent pool update
ResumeAgentPoolsUpdatePOST /api/v1/agentPools/{poolId}/updates/{updateId}/resumeResume an agent pool update
RetryAgentPoolsUpdatePOST /api/v1/agentPools/{poolId}/updates/{updateId}/retryRetry an agent pool update
StopAgentPoolsUpdatePOST /api/v1/agentPools/{poolId}/updates/{updateId}/stopStop an agent pool update
UpdateAgentPoolsUpdatePOST /api/v1/agentPools/{poolId}/updates/{updateId}Update an agent pool update by ID
UpdateAgentPoolsUpdateSettingsPOST /api/v1/agentPools/{poolId}/updates/settingsUpdate an agent pool update settings

ActivateAgentPoolsUpdate

AgentPoolUpdate ActivateAgentPoolsUpdate (string poolId, string updateId)

Activate an agent pool update

Activates a scheduled agent pool update

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ActivateAgentPoolsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var updateId = "updateId_example";  // string | ID of the update

            try
            {
                // Activate an agent pool update
                AgentPoolUpdate result = apiInstance.ActivateAgentPoolsUpdate(poolId, updateId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.ActivateAgentPoolsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
updateIdstringID of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
201Activated-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateAgentPoolsUpdate

AgentPoolUpdate CreateAgentPoolsUpdate (string poolId, AgentPoolUpdate agentPoolUpdate)

Create an agent pool update

Creates an agent pool update

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class CreateAgentPoolsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var agentPoolUpdate = new AgentPoolUpdate(); // AgentPoolUpdate | 

            try
            {
                // Create an agent pool update
                AgentPoolUpdate result = apiInstance.CreateAgentPoolsUpdate(poolId, agentPoolUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.CreateAgentPoolsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
agentPoolUpdateAgentPoolUpdate

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
201Created-
400Bad Request-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeactivateAgentPoolsUpdate

AgentPoolUpdate DeactivateAgentPoolsUpdate (string poolId, string updateId)

Deactivate an agent pool update

Deactivates scheduled agent pool update

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class DeactivateAgentPoolsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var updateId = "updateId_example";  // string | ID of the update

            try
            {
                // Deactivate an agent pool update
                AgentPoolUpdate result = apiInstance.DeactivateAgentPoolsUpdate(poolId, updateId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.DeactivateAgentPoolsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
updateIdstringID of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
201Deactivated-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAgentPoolsUpdate

void DeleteAgentPoolsUpdate (string poolId, string updateId)

Delete an agent pool update

Deletes agent pool update

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class DeleteAgentPoolsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var updateId = "updateId_example";  // string | ID of the update

            try
            {
                // Delete an agent pool update
                apiInstance.DeleteAgentPoolsUpdate(poolId, updateId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.DeleteAgentPoolsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
updateIdstringID of the update

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
204Deleted-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAgentPoolsUpdateInstance

AgentPoolUpdate GetAgentPoolsUpdateInstance (string poolId, string updateId)

Retrieve an agent pool update by ID

Retrieves an agent pool update by its updateId

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetAgentPoolsUpdateInstanceExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var updateId = "updateId_example";  // string | ID of the update

            try
            {
                // Retrieve an agent pool update by ID
                AgentPoolUpdate result = apiInstance.GetAgentPoolsUpdateInstance(poolId, updateId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.GetAgentPoolsUpdateInstance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
updateIdstringID of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAgentPoolsUpdateSettings

AgentPoolUpdateSetting GetAgentPoolsUpdateSettings (string poolId)

Retrieve an agent pool update's settings

Retrieves the current state of the agent pool update instance settings

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetAgentPoolsUpdateSettingsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to

            try
            {
                // Retrieve an agent pool update's settings
                AgentPoolUpdateSetting result = apiInstance.GetAgentPoolsUpdateSettings(poolId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.GetAgentPoolsUpdateSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to

Return type

AgentPoolUpdateSetting

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAgentPools

List<AgentPool> ListAgentPools (int? limitPerPoolType = null, AgentType? poolType = null, string after = null)

List all agent pools

Lists all agent pools with pagination support

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListAgentPoolsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var limitPerPoolType = 5;  // int? | Maximum number of agent pools returned (optional)  (default to 5)
            var poolType = (AgentType) "AD";  // AgentType? | Agent type to search for (optional) 
            var after = "after_example";  // 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](https://developer.okta.com/docs/api/#pagination). (optional) 

            try
            {
                // List all agent pools
                List<AgentPool> result = apiInstance.ListAgentPools(limitPerPoolType, poolType, after).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.ListAgentPools: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
limitPerPoolTypeint?Maximum number of agent pools returned[optional] [default to 5]
poolTypeAgentType?Agent type to search for[optional]
afterstringThe 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.[optional]

Return type

List<AgentPool>

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
403Forbidden-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAgentPoolsUpdates

List<AgentPoolUpdate> ListAgentPoolsUpdates (string poolId, bool? scheduled = null)

List all agent pool updates

Lists all agent pool updates

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListAgentPoolsUpdatesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var scheduled = true;  // bool? | Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates. (optional) 

            try
            {
                // List all agent pool updates
                List<AgentPoolUpdate> result = apiInstance.ListAgentPoolsUpdates(poolId, scheduled).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.ListAgentPoolsUpdates: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
scheduledbool?Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates.[optional]

Return type

List<AgentPoolUpdate>

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PauseAgentPoolsUpdate

AgentPoolUpdate PauseAgentPoolsUpdate (string poolId, string updateId)

Pause an agent pool update

Pauses a running or queued agent pool update

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class PauseAgentPoolsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var updateId = "updateId_example";  // string | ID of the update

            try
            {
                // Pause an agent pool update
                AgentPoolUpdate result = apiInstance.PauseAgentPoolsUpdate(poolId, updateId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.PauseAgentPoolsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
updateIdstringID of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
201Paused-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResumeAgentPoolsUpdate

AgentPoolUpdate ResumeAgentPoolsUpdate (string poolId, string updateId)

Resume an agent pool update

Resumes a running or queued agent pool update

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ResumeAgentPoolsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var updateId = "updateId_example";  // string | ID of the update

            try
            {
                // Resume an agent pool update
                AgentPoolUpdate result = apiInstance.ResumeAgentPoolsUpdate(poolId, updateId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.ResumeAgentPoolsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
updateIdstringID of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
201Resumed-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetryAgentPoolsUpdate

AgentPoolUpdate RetryAgentPoolsUpdate (string poolId, string updateId)

Retry an agent pool update

Retries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class RetryAgentPoolsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var updateId = "updateId_example";  // string | ID of the update

            try
            {
                // Retry an agent pool update
                AgentPoolUpdate result = apiInstance.RetryAgentPoolsUpdate(poolId, updateId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.RetryAgentPoolsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
updateIdstringID of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
201Retried-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StopAgentPoolsUpdate

AgentPoolUpdate StopAgentPoolsUpdate (string poolId, string updateId)

Stop an agent pool update

Stops an agent pool update

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class StopAgentPoolsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var updateId = "updateId_example";  // string | ID of the update

            try
            {
                // Stop an agent pool update
                AgentPoolUpdate result = apiInstance.StopAgentPoolsUpdate(poolId, updateId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.StopAgentPoolsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
updateIdstringID of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
201Stopped-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateAgentPoolsUpdate

AgentPoolUpdate UpdateAgentPoolsUpdate (string poolId, string updateId, AgentPoolUpdate agentPoolUpdate)

Update an agent pool update by ID

Updates an agent pool update instance and returns the latest agent pool update

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class UpdateAgentPoolsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var updateId = "updateId_example";  // string | ID of the update
            var agentPoolUpdate = new AgentPoolUpdate(); // AgentPoolUpdate | 

            try
            {
                // Update an agent pool update by ID
                AgentPoolUpdate result = apiInstance.UpdateAgentPoolsUpdate(poolId, updateId, agentPoolUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.UpdateAgentPoolsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
updateIdstringID of the update
agentPoolUpdateAgentPoolUpdate

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
201Updated-
400Bad Request-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateAgentPoolsUpdateSettings

AgentPoolUpdateSetting UpdateAgentPoolsUpdateSettings (string poolId, AgentPoolUpdateSetting agentPoolUpdateSetting)

Update an agent pool update settings

Updates an agent pool update instance settings

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class UpdateAgentPoolsUpdateSettingsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AgentPoolsApi(config);
            var poolId = "poolId_example";  // string | ID of the agent pool for which the settings apply to
            var agentPoolUpdateSetting = new AgentPoolUpdateSetting(); // AgentPoolUpdateSetting | 

            try
            {
                // Update an agent pool update settings
                AgentPoolUpdateSetting result = apiInstance.UpdateAgentPoolsUpdateSettings(poolId, agentPoolUpdateSetting);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AgentPoolsApi.UpdateAgentPoolsUpdateSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
poolIdstringID of the agent pool for which the settings apply to
agentPoolUpdateSettingAgentPoolUpdateSetting

Return type

AgentPoolUpdateSetting

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
201Updated-
400Bad Request-
403Forbidden-
404Not Found-
429Too Many Requests-

[Back to top] [Back to API list] [Back to Model list] [Back to README]