\AgentPoolApi

All URIs are relative to http://keyfactor.example.com

Method	HTTP request	Description
CreateAgentPools	POST /AgentPools	Creates an agent pool with the provided properties
DeleteAgentPoolsById	DELETE /AgentPools/{id}	Deletes the agent pool associated with the provided id
GetAgentPools	GET /AgentPools	Returns all agent pools according to the provided filter and output parameters
GetAgentPoolsAgents	GET /AgentPools/Agents	Returns all agents for the default agent pool
GetAgentPoolsById	GET /AgentPools/{id}	Returns a single agent pool associated with the provided id
UpdateAgentPools	PUT /AgentPools	Updates an existing agent pool with the provided properties

CreateAgentPools

OrchestratorPoolsAgentPoolGetResponse NewCreateAgentPoolsRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).OrchestratorPoolsAgentPoolCreationRequest(orchestratorPoolsAgentPoolCreationRequest).Execute()

Creates an agent pool with the provided properties

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
    orchestratorPoolsAgentPoolCreationRequest := *openapiclient.NewOrchestratorPoolsAgentPoolCreationRequest("Name_example") // OrchestratorPoolsAgentPoolCreationRequest | Agent pool properties to be applied to the new pool (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentPoolApi.NewCreateAgentPoolsRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).OrchestratorPoolsAgentPoolCreationRequest(orchestratorPoolsAgentPoolCreationRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentPoolApi.CreateAgentPools``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateAgentPools`: OrchestratorPoolsAgentPoolGetResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentPoolApi.CreateAgentPools`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateAgentPoolsRequest struct via the builder pattern

Name	Type	Description
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1
orchestratorPoolsAgentPoolCreationRequest	OrchestratorPoolsAgentPoolCreationRequest	Agent pool properties to be applied to the new pool

Return type

OrchestratorPoolsAgentPoolGetResponse

Authorization

basicAuth

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

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

DeleteAgentPoolsById

NewDeleteAgentPoolsByIdRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Deletes the agent pool associated with the provided id

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Keyfactor identifier (GUID) of the agent pool
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentPoolApi.NewDeleteAgentPoolsByIdRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentPoolApi.DeleteAgentPoolsById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	Keyfactor identifier (GUID) of the agent pool

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAgentPoolsByIdRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

GetAgentPools

[]OrchestratorPoolsAgentPoolGetResponse NewGetAgentPoolsRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Returns all agent pools according to the provided filter and output parameters

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    queryString := "queryString_example" // string | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) (optional)
    pageReturned := int32(56) // int32 | The current page within the result set to be returned (optional)
    returnLimit := int32(56) // int32 | Maximum number of records to be returned in a single call (optional)
    sortField := "sortField_example" // string | Field by which the results should be sorted (view results via Management Portal for sortable columns) (optional)
    sortAscending := openapiclient.Keyfactor.Common.QueryableExtensions.SortOrder(0) // KeyfactorCommonQueryableExtensionsSortOrder | Field sort direction [0=ascending, 1=descending] (optional)
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentPoolApi.NewGetAgentPoolsRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentPoolApi.GetAgentPools``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAgentPools`: []OrchestratorPoolsAgentPoolGetResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentPoolApi.GetAgentPools`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetAgentPoolsRequest struct via the builder pattern

Name	Type	Description
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]
queryString	string	Contents of the query (ex: field1 -eq value1 AND field2 -gt value2)
pageReturned	int32	The current page within the result set to be returned
returnLimit	int32	Maximum number of records to be returned in a single call
sortField	string	Field by which the results should be sorted (view results via Management Portal for sortable columns)
sortAscending	KeyfactorCommonQueryableExtensionsSortOrder	Field sort direction [0=ascending, 1=descending]
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1

Return type

[]OrchestratorPoolsAgentPoolGetResponse

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

GetAgentPoolsAgents

[]OrchestratorPoolsAgentPoolAgentGetResponse NewGetAgentPoolsAgentsRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Returns all agents for the default agent pool

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    queryString := "queryString_example" // string | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) (optional)
    pageReturned := int32(56) // int32 | The current page within the result set to be returned (optional)
    returnLimit := int32(56) // int32 | Maximum number of records to be returned in a single call (optional)
    sortField := "sortField_example" // string | Field by which the results should be sorted (view results via Management Portal for sortable columns) (optional)
    sortAscending := openapiclient.Keyfactor.Common.QueryableExtensions.SortOrder(0) // KeyfactorCommonQueryableExtensionsSortOrder | Field sort direction [0=ascending, 1=descending] (optional)
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentPoolApi.NewGetAgentPoolsAgentsRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentPoolApi.GetAgentPoolsAgents``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAgentPoolsAgents`: []OrchestratorPoolsAgentPoolAgentGetResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentPoolApi.GetAgentPoolsAgents`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetAgentPoolsAgentsRequest struct via the builder pattern

Name	Type	Description
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]
queryString	string	Contents of the query (ex: field1 -eq value1 AND field2 -gt value2)
pageReturned	int32	The current page within the result set to be returned
returnLimit	int32	Maximum number of records to be returned in a single call
sortField	string	Field by which the results should be sorted (view results via Management Portal for sortable columns)
sortAscending	KeyfactorCommonQueryableExtensionsSortOrder	Field sort direction [0=ascending, 1=descending]
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1

Return type

[]OrchestratorPoolsAgentPoolAgentGetResponse

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

GetAgentPoolsById

OrchestratorPoolsAgentPoolGetResponse NewGetAgentPoolsByIdRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Returns a single agent pool associated with the provided id

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Keyfactor (GUID) identifier of the agent pool
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentPoolApi.NewGetAgentPoolsByIdRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentPoolApi.GetAgentPoolsById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAgentPoolsById`: OrchestratorPoolsAgentPoolGetResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentPoolApi.GetAgentPoolsById`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	Keyfactor (GUID) identifier of the agent pool

Other Parameters

Other parameters are passed through a pointer to a apiGetAgentPoolsByIdRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OrchestratorPoolsAgentPoolGetResponse

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

UpdateAgentPools

OrchestratorPoolsAgentPoolGetResponse NewUpdateAgentPoolsRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).OrchestratorPoolsAgentPoolUpdateRequest(orchestratorPoolsAgentPoolUpdateRequest).Execute()

Updates an existing agent pool with the provided properties

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
    orchestratorPoolsAgentPoolUpdateRequest := *openapiclient.NewOrchestratorPoolsAgentPoolUpdateRequest("AgentPoolId_example", "Name_example") // OrchestratorPoolsAgentPoolUpdateRequest | Agent pool properties to be applied to the existing pool (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentPoolApi.NewUpdateAgentPoolsRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).OrchestratorPoolsAgentPoolUpdateRequest(orchestratorPoolsAgentPoolUpdateRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentPoolApi.UpdateAgentPools``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateAgentPools`: OrchestratorPoolsAgentPoolGetResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentPoolApi.UpdateAgentPools`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUpdateAgentPoolsRequest struct via the builder pattern

Name	Type	Description
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1
orchestratorPoolsAgentPoolUpdateRequest	OrchestratorPoolsAgentPoolUpdateRequest	Agent pool properties to be applied to the existing pool

Return type

OrchestratorPoolsAgentPoolGetResponse

Authorization

basicAuth

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

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

Uh oh!

FilesExpand file tree

AgentPoolApi.md

Latest commit

History

AgentPoolApi.md

File metadata and controls

\AgentPoolApi

CreateAgentPools

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteAgentPoolsById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAgentPools

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAgentPoolsAgents

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAgentPoolsById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateAgentPools

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers