Skip to content

AgentBlueprintApi.md

Latest commit

 

History

History
531 lines (362 loc) · 21 KB

AgentBlueprintApi.md

File metadata and controls

531 lines (362 loc) · 21 KB
Raw

\AgentBlueprintApi

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

Method HTTP request Description
CreateAgentBluePrintApplyBlueprint POST /AgentBluePrint/ApplyBlueprint Applies the selected agent blueprint to the provided agents
CreateAgentBluePrintGenerateBluePrint POST /AgentBluePrint/GenerateBluePrint Generates an agent blueprint from the provided agents
DeleteAgentBluePrintById DELETE /AgentBluePrint/{id} Deletes an agent blueprint by its Keyfactor identifier
GetAgentBluePrint GET /AgentBluePrint Returns all agent blueprints according to the provided filter and output parameters
GetAgentBluePrintById GET /AgentBluePrint/{id} Returns an agent blueprint according to the provided filter and output parameters
GetAgentBluePrintByIdJobs GET /AgentBluePrint/{id}/Jobs Gets the agent blueprint scheduled jobs
GetAgentBluePrintByIdStores GET /AgentBluePrint/{id}/Stores Gets the agent blueprint certificate stores

CreateAgentBluePrintApplyBlueprint

NewCreateAgentBluePrintApplyBlueprintRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).TemplateId(templateId).XKeyfactorApiVersion(xKeyfactorApiVersion).RequestBody(requestBody).Execute()

Applies the selected agent blueprint to the provided agents

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    templateId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Agent blueprint to apply to the agents (optional)
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
    requestBody := []string{"Property_example"} // []string | Agents to apply the blueprints to (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient]
templateId string Agent blueprint to apply to the agents
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1
requestBody []string Agents to apply the blueprints to

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: Not defined

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

CreateAgentBluePrintGenerateBluePrint

OrchestratorsAgentBlueprintResponse NewCreateAgentBluePrintGenerateBluePrintRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).AgentId(agentId).Name(name).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Generates an agent blueprint from the provided agents

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    agentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Agent to generate a blueprint from (optional)
    name := "name_example" // string | Name of the new agent blueprint (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.AgentBlueprintApi.NewCreateAgentBluePrintGenerateBluePrintRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).AgentId(agentId).Name(name).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentBlueprintApi.CreateAgentBluePrintGenerateBluePrint``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateAgentBluePrintGenerateBluePrint`: OrchestratorsAgentBlueprintResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentBlueprintApi.CreateAgentBluePrintGenerateBluePrint`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient]
agentId string Agent to generate a blueprint from
name string Name of the new agent blueprint
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1

Return type

OrchestratorsAgentBlueprintResponse

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]

DeleteAgentBluePrintById

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

Deletes an agent blueprint by its Keyfactor identifier

Example

package main

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

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Keyfactor agent blueprint identifier (GUID)
    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.AgentBlueprintApi.NewDeleteAgentBluePrintByIdRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentBlueprintApi.DeleteAgentBluePrintById``: %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 agent blueprint identifier (GUID)

Other Parameters

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

Name Type Description Notes

xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 |

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]

GetAgentBluePrint

[]OrchestratorsAgentBlueprintResponse NewGetAgentBluePrintRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Returns all agent blueprints 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]
    pageReturned := int32(56) // int32 |  (optional)
    returnLimit := int32(56) // int32 |  (optional)
    sortField := "sortField_example" // string |  (optional)
    sortAscending := openapiclient.Keyfactor.Common.QueryableExtensions.SortOrder(0) // KeyfactorCommonQueryableExtensionsSortOrder |  (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.AgentBlueprintApi.NewGetAgentBluePrintRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentBlueprintApi.GetAgentBluePrint``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAgentBluePrint`: []OrchestratorsAgentBlueprintResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentBlueprintApi.GetAgentBluePrint`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient]
pageReturned int32
returnLimit int32
sortField string
sortAscending KeyfactorCommonQueryableExtensionsSortOrder
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1

Return type

[]OrchestratorsAgentBlueprintResponse

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]

GetAgentBluePrintById

OrchestratorsAgentBlueprintResponse NewGetAgentBluePrintByIdRequest(ctx, id2).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Id(id).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Returns an agent blueprint according to the provided filter and output parameters

Example

package main

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

func main() {
    id2 := "id_example" // string | 
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Returns a single agent blueprint associated with the provided id (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.AgentBlueprintApi.NewGetAgentBluePrintByIdRequest(context.Background(), id2).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Id(id).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentBlueprintApi.GetAgentBluePrintById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAgentBluePrintById`: OrchestratorsAgentBlueprintResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentBlueprintApi.GetAgentBluePrintById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id2 string

Other Parameters

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

Name Type Description Notes

xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | id | string | Returns a single agent blueprint associated with the provided id | xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 |

Return type

OrchestratorsAgentBlueprintResponse

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]

GetAgentBluePrintByIdJobs

[]OrchestratorsAgentBlueprintJobsResponse NewGetAgentBluePrintByIdJobsRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Gets the agent blueprint scheduled jobs

Example

package main

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

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    pageReturned := int32(56) // int32 |  (optional)
    returnLimit := int32(56) // int32 |  (optional)
    sortField := "sortField_example" // string |  (optional)
    sortAscending := openapiclient.Keyfactor.Common.QueryableExtensions.SortOrder(0) // KeyfactorCommonQueryableExtensionsSortOrder |  (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.AgentBlueprintApi.NewGetAgentBluePrintByIdJobsRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentBlueprintApi.GetAgentBluePrintByIdJobs``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAgentBluePrintByIdJobs`: []OrchestratorsAgentBlueprintJobsResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentBlueprintApi.GetAgentBluePrintByIdJobs`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

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

Name Type Description Notes

xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | pageReturned | int32 | | returnLimit | int32 | | sortField | string | | sortAscending | KeyfactorCommonQueryableExtensionsSortOrder | | xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 |

Return type

[]OrchestratorsAgentBlueprintJobsResponse

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]

GetAgentBluePrintByIdStores

[]OrchestratorsAgentBlueprintStoresResponse NewGetAgentBluePrintByIdStoresRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Gets the agent blueprint certificate stores

Example

package main

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

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    pageReturned := int32(56) // int32 |  (optional)
    returnLimit := int32(56) // int32 |  (optional)
    sortField := "sortField_example" // string |  (optional)
    sortAscending := openapiclient.Keyfactor.Common.QueryableExtensions.SortOrder(0) // KeyfactorCommonQueryableExtensionsSortOrder |  (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.AgentBlueprintApi.NewGetAgentBluePrintByIdStoresRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentBlueprintApi.GetAgentBluePrintByIdStores``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAgentBluePrintByIdStores`: []OrchestratorsAgentBlueprintStoresResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentBlueprintApi.GetAgentBluePrintByIdStores`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

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

Name Type Description Notes

xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | pageReturned | int32 | | returnLimit | int32 | | sortField | string | | sortAscending | KeyfactorCommonQueryableExtensionsSortOrder | | xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 |

Return type

[]OrchestratorsAgentBlueprintStoresResponse

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]