Okta.Sdk.Api.AgentPoolsApi

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

Method	HTTP request	Description
ActivateAgentPoolsUpdate	POST /api/v1/agentPools/{poolId}/updates/{updateId}/activate	Activate an Agent Pool update
CreateAgentPoolsUpdate	POST /api/v1/agentPools/{poolId}/updates	Create an Agent Pool update
DeactivateAgentPoolsUpdate	POST /api/v1/agentPools/{poolId}/updates/{updateId}/deactivate	Deactivate an Agent Pool update
DeleteAgentPoolsUpdate	DELETE /api/v1/agentPools/{poolId}/updates/{updateId}	Delete an Agent Pool update
GetAgentPoolsUpdateInstance	GET /api/v1/agentPools/{poolId}/updates/{updateId}	Retrieve an Agent Pool update by id
GetAgentPoolsUpdateSettings	GET /api/v1/agentPools/{poolId}/updates/settings	Retrieve an Agent Pool update's settings
ListAgentPools	GET /api/v1/agentPools	List all Agent Pools
ListAgentPoolsUpdates	GET /api/v1/agentPools/{poolId}/updates	List all Agent Pool updates
PauseAgentPoolsUpdate	POST /api/v1/agentPools/{poolId}/updates/{updateId}/pause	Pause an Agent Pool update
ResumeAgentPoolsUpdate	POST /api/v1/agentPools/{poolId}/updates/{updateId}/resume	Resume an Agent Pool update
RetryAgentPoolsUpdate	POST /api/v1/agentPools/{poolId}/updates/{updateId}/retry	Retry an Agent Pool update
StopAgentPoolsUpdate	POST /api/v1/agentPools/{poolId}/updates/{updateId}/stop	Stop an Agent Pool update
UpdateAgentPoolsUpdate	POST /api/v1/agentPools/{poolId}/updates/{updateId}	Update an Agent Pool update by id
UpdateAgentPoolsUpdateSettings	POST /api/v1/agentPools/{poolId}/updates/settings	Update an Agent Pool update settings

ActivateAgentPoolsUpdate

AgentPoolUpdate ActivateAgentPoolsUpdate (string poolId, string updateId)

Activate an Agent Pool update

Activates 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 will apply
            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
updateId	string	Id of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Activated	-
403	Forbidden	-
404	Not Found	-
429	Too 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 \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.

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 will apply
            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
agentPoolUpdate	AgentPoolUpdate

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too 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 will apply
            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
updateId	string	Id of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Deactivated	-
403	Forbidden	-
404	Not Found	-
429	Too 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 will apply
            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
updateId	string	Id 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 code	Description	Response headers
204	Deleted	-
403	Forbidden	-
404	Not Found	-
429	Too 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 Agent pool update from 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 will apply
            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
updateId	string	Id of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too 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 will apply

            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply

Return type

AgentPoolUpdateSetting

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too 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 AgentPools being 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](/#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

Name	Type	Description	Notes
limitPerPoolType	int?	Maximum number of AgentPools being returned	[optional] [default to 5]
poolType	AgentType?	Agent type to search for	[optional]
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.	[optional]

Return type

List<AgentPool>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
429	Too 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 will apply
            var scheduled = true;  // bool? | Scope the list only to scheduled or ad-hoc updates. If the parameter is not provided we will return the whole 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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
scheduled	bool?	Scope the list only to scheduled or ad-hoc updates. If the parameter is not provided we will return the whole 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 code	Description	Response headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too 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 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 will apply
            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
updateId	string	Id of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Paused	-
403	Forbidden	-
404	Not Found	-
429	Too 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 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 will apply
            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
updateId	string	Id of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Resumed	-
403	Forbidden	-
404	Not Found	-
429	Too 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 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 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 will apply
            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
updateId	string	Id of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Retried	-
403	Forbidden	-
404	Not Found	-
429	Too 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 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 will apply
            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
updateId	string	Id of the update

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Stopped	-
403	Forbidden	-
404	Not Found	-
429	Too 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 Agent pool update and return 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 will apply
            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

Name	Type	Description
poolId	string	Id of the agent pool for which the settings will apply
updateId	string	Id of the update
agentPoolUpdate	AgentPoolUpdate

Return type

AgentPoolUpdate

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Updated	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too 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 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 will apply
            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

Name	Type	Description	Notes
poolId	string	Id of the agent pool for which the settings will apply
agentPoolUpdateSetting	AgentPoolUpdateSetting

Return type

AgentPoolUpdateSetting

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

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

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

Files

AgentPoolsApi.md

Latest commit

History

AgentPoolsApi.md

File metadata and controls

Okta.Sdk.Api.AgentPoolsApi

ActivateAgentPoolsUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateAgentPoolsUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeactivateAgentPoolsUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteAgentPoolsUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetAgentPoolsUpdateInstance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetAgentPoolsUpdateSettings

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListAgentPools

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListAgentPoolsUpdates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PauseAgentPoolsUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ResumeAgentPoolsUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

RetryAgentPoolsUpdate

Example

Parameters