\ServerApi

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

Method	HTTP request	Description
ServerAddAccess	Post /SSH/Servers/Access	Updates logons and users with access to those logons for an existing server
ServerCreateServer	Post /SSH/Servers	Creates a server with the provided properties
ServerDelete	Delete /SSH/Servers/{id}	Deletes a Server associated with the provided identifier
ServerGet	Get /SSH/Servers/{id}	Returns a Server associated with the provided identifier
ServerGetAccess	Get /SSH/Servers/Access/{id}	Retrieves logons and users with access to those logons for an existing server
ServerQueryServers	Get /SSH/Servers	Returns all servers according to the provided filter parameters
ServerRemoveAccess	Delete /SSH/Servers/Access	Updates logons and users with access to those logons for an existing server
ServerUpdateServer	Put /SSH/Servers	Updates an existing server with the provided properties

ServerAddAccess

ModelsSSHAccessServerAccessResponse ServerAddAccess(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).ServerAccess(serverAccess).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Updates logons and users with access to those logons for an existing server

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    serverAccess := *openapiclient.NewModelsSSHAccessServerAccessRequest(int32(123), []openapiclient.ModelsSSHAccessLogonUserAccessRequest{*openapiclient.NewModelsSSHAccessLogonUserAccessRequest()}) // ModelsSSHAccessServerAccessRequest | Logons and users to be applied to the existing server
    xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]	[default to "APIClient"]
serverAccess	ModelsSSHAccessServerAccessRequest	Logons and users to be applied to the existing server
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1	[default to "1"]

Return type

ModelsSSHAccessServerAccessResponse

Authorization

basicAuth

HTTP request headers

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

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

ServerCreateServer

ModelsSSHServersServerResponse ServerCreateServer(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).CreationRequest(creationRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Creates a server with the provided properties

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    creationRequest := *openapiclient.NewModelsSSHServersServerCreationRequest("00000000-0000-0000-0000-000000000000", "Hostname_example", "00000000-0000-0000-0000-000000000000") // ModelsSSHServersServerCreationRequest | Server properties to be applied to the newserver
    xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]	[default to "APIClient"]
creationRequest	ModelsSSHServersServerCreationRequest	Server properties to be applied to the newserver
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1	[default to "1"]

Return type

ModelsSSHServersServerResponse

Authorization

basicAuth

HTTP request headers

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

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

ServerDelete

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

Deletes a Server associated with the provided identifier

Example

package main

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

func main() {
    id := int32(56) // int32 | Keyfactor identifer of the Server to be deleted
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.ServerDelete(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.ServerDelete``: %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	int32	Keyfactor identifer of the Server to be deleted

Other Parameters

Other parameters are passed through a pointer to a apiServerDeleteRequest 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]

ServerGet

ModelsSSHServersServerResponse ServerGet(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Returns a Server associated with the provided identifier

Example

package main

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

func main() {
    id := int32(56) // int32 | Keyfactor identifier of the Server
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32	Keyfactor identifier of the Server

Other Parameters

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

Name	Type	Description	Notes

Return type

ModelsSSHServersServerResponse

Authorization

basicAuth

HTTP request headers

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

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

ServerGetAccess

ModelsSSHAccessServerAccessResponse ServerGetAccess(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Retrieves logons and users with access to those logons for an existing server

Example

package main

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

func main() {
    id := int32(56) // int32 | Id of the existing server
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32	Id of the existing server

Other Parameters

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

Name	Type	Description	Notes

Return type

ModelsSSHAccessServerAccessResponse

Authorization

basicAuth

HTTP request headers

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

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

ServerQueryServers

[]ModelsSSHServersServerResponse ServerQueryServers(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PqQueryString(pqQueryString).PqPageReturned(pqPageReturned).PqReturnLimit(pqReturnLimit).PqSortField(pqSortField).PqSortAscending(pqSortAscending).Execute()

Returns all servers according to the provided filter parameters

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")
    pqQueryString := "pqQueryString_example" // string | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) (optional)
    pqPageReturned := int32(56) // int32 | The current page within the result set to be returned (optional)
    pqReturnLimit := int32(56) // int32 | Maximum number of records to be returned in a single call (optional)
    pqSortField := "pqSortField_example" // string | Field by which the results should be sorted (view results via Management Portal for sortable columns) (optional)
    pqSortAscending := int32(56) // int32 | Field sort direction [0=ascending, 1=descending] (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.ServerQueryServers(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PqQueryString(pqQueryString).PqPageReturned(pqPageReturned).PqReturnLimit(pqReturnLimit).PqSortField(pqSortField).PqSortAscending(pqSortAscending).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.ServerQueryServers``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ServerQueryServers`: []ModelsSSHServersServerResponse
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.ServerQueryServers`: %v\n", resp)
}

Path Parameters

Other Parameters

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

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

Return type

[]ModelsSSHServersServerResponse

Authorization

basicAuth

HTTP request headers

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

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

ServerRemoveAccess

ModelsSSHAccessServerAccessResponse ServerRemoveAccess(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).ServerAccess(serverAccess).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Updates logons and users with access to those logons for an existing server

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    serverAccess := *openapiclient.NewModelsSSHAccessServerAccessRequest(int32(123), []openapiclient.ModelsSSHAccessLogonUserAccessRequest{*openapiclient.NewModelsSSHAccessLogonUserAccessRequest()}) // ModelsSSHAccessServerAccessRequest | Logons and users to be removed from the existing server
    xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]	[default to "APIClient"]
serverAccess	ModelsSSHAccessServerAccessRequest	Logons and users to be removed from the existing server
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1	[default to "1"]

Return type

ModelsSSHAccessServerAccessResponse

Authorization

basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

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

ServerUpdateServer

ModelsSSHServersServerResponse ServerUpdateServer(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).UpdateRequest(updateRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Updates an existing server with the provided properties

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    updateRequest := *openapiclient.NewModelsSSHServersServerUpdateRequest(int32(123)) // ModelsSSHServersServerUpdateRequest | Server properties to be applied to the existing server
    xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]	[default to "APIClient"]
updateRequest	ModelsSSHServersServerUpdateRequest	Server properties to be applied to the existing server
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1	[default to "1"]

Return type

ModelsSSHServersServerResponse

Authorization

basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

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

Files

ServerApi.md

Latest commit

History

ServerApi.md

File metadata and controls

\ServerApi

ServerAddAccess

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ServerCreateServer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ServerDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ServerGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ServerGetAccess

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ServerQueryServers

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ServerRemoveAccess

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ServerUpdateServer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers