Skip to content

Latest commit

 

History

History
574 lines (384 loc) · 26.1 KB

MonitoringApi.md

File metadata and controls

574 lines (384 loc) · 26.1 KB
Raw

\MonitoringApi

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

Method HTTP request Description
MonitoringAddRevocationMonitoring Post /Monitoring/Revocation Add a revocation monitoring endpoint
MonitoringDeleteRevocationMonitoring Delete /Monitoring/Revocation/{id} Delete a revocation monitoring endpoint
MonitoringEditRevocationMonitoring Put /Monitoring/Revocation Edit a revocation monitoring endpoint
MonitoringGetRevocationMonitoring Get /Monitoring/Revocation/{id} Get a revocation monitoring endpoint
MonitoringGetRevocationMonitoringEndpoints Get /Monitoring/Revocation Gets all revocation monitoring endpoints according to the provided filter and output parameters
MonitoringResolveOCSP Post /Monitoring/ResolveOCSP Resolve the Certificate authority given
MonitoringTestAllRevocationMonitoringAlert Post /Monitoring/Revocation/TestAll Test All Alerts
MonitoringTestRevocationMonitoringAlert Post /Monitoring/Revocation/Test Test Alert

MonitoringAddRevocationMonitoring

KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse MonitoringAddRevocationMonitoring(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Endpoint(endpoint).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Add a revocation monitoring endpoint

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    endpoint := *openapiclient.NewKeyfactorApiModelsMonitoringRevocationMonitoringCreationRequest("Name_example", "EndpointType_example", "Location_example", *openapiclient.NewKeyfactorApiModelsMonitoringDashboardRequest(false)) // KeyfactorApiModelsMonitoringRevocationMonitoringCreationRequest | Information for the new endpoint
    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.MonitoringApi.MonitoringAddRevocationMonitoring(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Endpoint(endpoint).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitoringApi.MonitoringAddRevocationMonitoring``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitoringAddRevocationMonitoring`: KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitoringApi.MonitoringAddRevocationMonitoring`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
endpoint KeyfactorApiModelsMonitoringRevocationMonitoringCreationRequest Information for the new endpoint
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse

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]

MonitoringDeleteRevocationMonitoring

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

Delete a revocation monitoring endpoint

Example

package main

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

func main() {
    id := int32(56) // int32 | Id for the revocation monitoring endpoint
    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.MonitoringApi.MonitoringDeleteRevocationMonitoring(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitoringApi.MonitoringDeleteRevocationMonitoring``: %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 Id for the revocation monitoring endpoint

Other Parameters

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

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]

MonitoringEditRevocationMonitoring

KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse MonitoringEditRevocationMonitoring(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Endpoint(endpoint).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Edit a revocation monitoring endpoint

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    endpoint := *openapiclient.NewKeyfactorApiModelsMonitoringRevocationMonitoringUpdateRequest("Name_example", "EndpointType_example", "Location_example", *openapiclient.NewKeyfactorApiModelsMonitoringDashboardRequest(false)) // KeyfactorApiModelsMonitoringRevocationMonitoringUpdateRequest | Information for the endpoint
    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.MonitoringApi.MonitoringEditRevocationMonitoring(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Endpoint(endpoint).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitoringApi.MonitoringEditRevocationMonitoring``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitoringEditRevocationMonitoring`: KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitoringApi.MonitoringEditRevocationMonitoring`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
endpoint KeyfactorApiModelsMonitoringRevocationMonitoringUpdateRequest Information for the endpoint
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse

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]

MonitoringGetRevocationMonitoring

KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse MonitoringGetRevocationMonitoring(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Get a revocation monitoring endpoint

Example

package main

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

func main() {
    id := int32(56) // int32 | Id for the endpoint to get
    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.MonitoringApi.MonitoringGetRevocationMonitoring(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitoringApi.MonitoringGetRevocationMonitoring``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitoringGetRevocationMonitoring`: KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitoringApi.MonitoringGetRevocationMonitoring`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 Id for the endpoint to get

Other Parameters

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

Return type

KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse

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]

MonitoringGetRevocationMonitoringEndpoints

[]KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse MonitoringGetRevocationMonitoringEndpoints(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PagedQueryQueryString(pagedQueryQueryString).PagedQueryPageReturned(pagedQueryPageReturned).PagedQueryReturnLimit(pagedQueryReturnLimit).PagedQuerySortField(pagedQuerySortField).PagedQuerySortAscending(pagedQuerySortAscending).Execute()

Gets all revocation monitoring endpoints according to the provided filter and output 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")
    pagedQueryQueryString := "pagedQueryQueryString_example" // string | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) (optional)
    pagedQueryPageReturned := int32(56) // int32 | The current page within the result set to be returned (optional)
    pagedQueryReturnLimit := int32(56) // int32 | Maximum number of records to be returned in a single call (optional)
    pagedQuerySortField := "pagedQuerySortField_example" // string | Field by which the results should be sorted (view results via Management Portal for sortable columns) (optional)
    pagedQuerySortAscending := 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.MonitoringApi.MonitoringGetRevocationMonitoringEndpoints(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PagedQueryQueryString(pagedQueryQueryString).PagedQueryPageReturned(pagedQueryPageReturned).PagedQueryReturnLimit(pagedQueryReturnLimit).PagedQuerySortField(pagedQuerySortField).PagedQuerySortAscending(pagedQuerySortAscending).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitoringApi.MonitoringGetRevocationMonitoringEndpoints``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitoringGetRevocationMonitoringEndpoints`: []KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitoringApi.MonitoringGetRevocationMonitoringEndpoints`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiMonitoringGetRevocationMonitoringEndpointsRequest 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"]
pagedQueryQueryString string Contents of the query (ex: field1 -eq value1 AND field2 -gt value2)
pagedQueryPageReturned int32 The current page within the result set to be returned
pagedQueryReturnLimit int32 Maximum number of records to be returned in a single call
pagedQuerySortField string Field by which the results should be sorted (view results via Management Portal for sortable columns)
pagedQuerySortAscending int32 Field sort direction [0=ascending, 1=descending]

Return type

[]KeyfactorApiModelsMonitoringRevocationMonitoringDefinitionResponse

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]

MonitoringResolveOCSP

KeyfactorApiModelsMonitoringOCSPParametersResponse MonitoringResolveOCSP(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Endpoint(endpoint).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Resolve the Certificate authority given

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    endpoint := *openapiclient.NewKeyfactorApiModelsMonitoringOCSPParametersRequest() // KeyfactorApiModelsMonitoringOCSPParametersRequest | Information for the new endpoint
    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.MonitoringApi.MonitoringResolveOCSP(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Endpoint(endpoint).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitoringApi.MonitoringResolveOCSP``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitoringResolveOCSP`: KeyfactorApiModelsMonitoringOCSPParametersResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitoringApi.MonitoringResolveOCSP`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
endpoint KeyfactorApiModelsMonitoringOCSPParametersRequest Information for the new endpoint
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

KeyfactorApiModelsMonitoringOCSPParametersResponse

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]

MonitoringTestAllRevocationMonitoringAlert

KeyfactorApiModelsMonitoringRevocationMonitoringAlertTestResponse MonitoringTestAllRevocationMonitoringAlert(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).RevocationMonitoringAlertTestRequest(revocationMonitoringAlertTestRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Test All Alerts

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    revocationMonitoringAlertTestRequest := *openapiclient.NewKeyfactorApiModelsMonitoringRevocationMonitoringAlertTestAllRequest() // KeyfactorApiModelsMonitoringRevocationMonitoringAlertTestAllRequest | Information about the revocation monitoring alert test
    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.MonitoringApi.MonitoringTestAllRevocationMonitoringAlert(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).RevocationMonitoringAlertTestRequest(revocationMonitoringAlertTestRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitoringApi.MonitoringTestAllRevocationMonitoringAlert``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitoringTestAllRevocationMonitoringAlert`: KeyfactorApiModelsMonitoringRevocationMonitoringAlertTestResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitoringApi.MonitoringTestAllRevocationMonitoringAlert`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
revocationMonitoringAlertTestRequest KeyfactorApiModelsMonitoringRevocationMonitoringAlertTestAllRequest Information about the revocation monitoring alert test
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

KeyfactorApiModelsMonitoringRevocationMonitoringAlertTestResponse

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]

MonitoringTestRevocationMonitoringAlert

KeyfactorApiModelsMonitoringRevocationMonitoringAlertTestResponse MonitoringTestRevocationMonitoringAlert(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).RevocationMonitoringAlertTestRequest(revocationMonitoringAlertTestRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Test Alert

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    revocationMonitoringAlertTestRequest := *openapiclient.NewKeyfactorApiModelsMonitoringRevocationMonitoringAlertTestRequest() // KeyfactorApiModelsMonitoringRevocationMonitoringAlertTestRequest | Information about the revocation monitoring alert test
    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.MonitoringApi.MonitoringTestRevocationMonitoringAlert(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).RevocationMonitoringAlertTestRequest(revocationMonitoringAlertTestRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitoringApi.MonitoringTestRevocationMonitoringAlert``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitoringTestRevocationMonitoringAlert`: KeyfactorApiModelsMonitoringRevocationMonitoringAlertTestResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitoringApi.MonitoringTestRevocationMonitoringAlert`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
revocationMonitoringAlertTestRequest KeyfactorApiModelsMonitoringRevocationMonitoringAlertTestRequest Information about the revocation monitoring alert test
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

KeyfactorApiModelsMonitoringRevocationMonitoringAlertTestResponse

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]