Skip to content

Latest commit

 

History

History
641 lines (428 loc) · 28.3 KB

ExpirationAlertApi.md

File metadata and controls

641 lines (428 loc) · 28.3 KB
Raw

\ExpirationAlertApi

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

Method HTTP request Description
ExpirationAlertAddExpirationAlert Post /Alerts/Expiration Add an expiration alert
ExpirationAlertDeleteExpirationAlert Delete /Alerts/Expiration/{id} Delete an expiration alert
ExpirationAlertEditExpirationAlert Put /Alerts/Expiration Edit an expiration alert
ExpirationAlertEditSchedule Put /Alerts/Expiration/Schedule Edit schedule
ExpirationAlertGetExpirationAlert Get /Alerts/Expiration/{id} Get an expiration alert
ExpirationAlertGetExpirationAlerts Get /Alerts/Expiration Gets all expiration alerts according to the provided filter and output parameters
ExpirationAlertGetSchedule Get /Alerts/Expiration/Schedule Get the schedule for expiration alerts
ExpirationAlertTestAllExpirationAlert Post /Alerts/Expiration/TestAll Test All Expiration Alerts
ExpirationAlertTestExpirationAlert Post /Alerts/Expiration/Test Test an Expiration Alert

ExpirationAlertAddExpirationAlert

KeyfactorApiModelsAlertsExpirationExpirationAlertDefinitionResponse ExpirationAlertAddExpirationAlert(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Req(req).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Add an expiration 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")
    req := *openapiclient.NewKeyfactorApiModelsAlertsExpirationExpirationAlertCreationRequest("DisplayName_example", "Subject_example", "Message_example", int32(123)) // KeyfactorApiModelsAlertsExpirationExpirationAlertCreationRequest | Information for the new alert
    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.ExpirationAlertApi.ExpirationAlertAddExpirationAlert(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Req(req).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ExpirationAlertApi.ExpirationAlertAddExpirationAlert``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ExpirationAlertAddExpirationAlert`: KeyfactorApiModelsAlertsExpirationExpirationAlertDefinitionResponse
    fmt.Fprintf(os.Stdout, "Response from `ExpirationAlertApi.ExpirationAlertAddExpirationAlert`: %v\n", resp)
}

Path Parameters

Other Parameters

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

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

Return type

KeyfactorApiModelsAlertsExpirationExpirationAlertDefinitionResponse

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]

ExpirationAlertDeleteExpirationAlert

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

Delete an expiration alert

Example

package main

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

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

Other Parameters

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

ExpirationAlertEditExpirationAlert

KeyfactorApiModelsAlertsExpirationExpirationAlertDefinitionResponse ExpirationAlertEditExpirationAlert(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Req(req).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Edit an expiration 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")
    req := *openapiclient.NewKeyfactorApiModelsAlertsExpirationExpirationAlertUpdateRequest("DisplayName_example", "Subject_example", "Message_example", int32(123)) // KeyfactorApiModelsAlertsExpirationExpirationAlertUpdateRequest | Information for the expiration alert
    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.ExpirationAlertApi.ExpirationAlertEditExpirationAlert(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Req(req).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ExpirationAlertApi.ExpirationAlertEditExpirationAlert``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ExpirationAlertEditExpirationAlert`: KeyfactorApiModelsAlertsExpirationExpirationAlertDefinitionResponse
    fmt.Fprintf(os.Stdout, "Response from `ExpirationAlertApi.ExpirationAlertEditExpirationAlert`: %v\n", resp)
}

Path Parameters

Other Parameters

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

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

Return type

KeyfactorApiModelsAlertsExpirationExpirationAlertDefinitionResponse

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]

ExpirationAlertEditSchedule

KeyfactorApiModelsAlertsAlertScheduleAlertScheduleResponse ExpirationAlertEditSchedule(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).NewSchedule(newSchedule).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Edit schedule

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    newSchedule := *openapiclient.NewKeyfactorApiModelsAlertsAlertScheduleAlertScheduleRequest() // KeyfactorApiModelsAlertsAlertScheduleAlertScheduleRequest | 
    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.ExpirationAlertApi.ExpirationAlertEditSchedule(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).NewSchedule(newSchedule).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ExpirationAlertApi.ExpirationAlertEditSchedule``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ExpirationAlertEditSchedule`: KeyfactorApiModelsAlertsAlertScheduleAlertScheduleResponse
    fmt.Fprintf(os.Stdout, "Response from `ExpirationAlertApi.ExpirationAlertEditSchedule`: %v\n", resp)
}

Path Parameters

Other Parameters

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

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

Return type

KeyfactorApiModelsAlertsAlertScheduleAlertScheduleResponse

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]

ExpirationAlertGetExpirationAlert

KeyfactorApiModelsAlertsExpirationExpirationAlertDefinitionResponse ExpirationAlertGetExpirationAlert(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Get an expiration alert

Example

package main

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

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

Other Parameters

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

KeyfactorApiModelsAlertsExpirationExpirationAlertDefinitionResponse

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]

ExpirationAlertGetExpirationAlerts

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

Gets all expiration alerts 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.ExpirationAlertApi.ExpirationAlertGetExpirationAlerts(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 `ExpirationAlertApi.ExpirationAlertGetExpirationAlerts``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ExpirationAlertGetExpirationAlerts`: []KeyfactorApiModelsAlertsExpirationExpirationAlertDefinitionResponse
    fmt.Fprintf(os.Stdout, "Response from `ExpirationAlertApi.ExpirationAlertGetExpirationAlerts`: %v\n", resp)
}

Path Parameters

Other Parameters

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

[]KeyfactorApiModelsAlertsExpirationExpirationAlertDefinitionResponse

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]

ExpirationAlertGetSchedule

KeyfactorApiModelsAlertsAlertScheduleAlertScheduleResponse ExpirationAlertGetSchedule(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Get the schedule for expiration 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")
    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.ExpirationAlertApi.ExpirationAlertGetSchedule(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ExpirationAlertApi.ExpirationAlertGetSchedule``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ExpirationAlertGetSchedule`: KeyfactorApiModelsAlertsAlertScheduleAlertScheduleResponse
    fmt.Fprintf(os.Stdout, "Response from `ExpirationAlertApi.ExpirationAlertGetSchedule`: %v\n", resp)
}

Path Parameters

Other Parameters

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

KeyfactorApiModelsAlertsAlertScheduleAlertScheduleResponse

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]

ExpirationAlertTestAllExpirationAlert

KeyfactorApiModelsAlertsExpirationExpirationAlertTestResponse ExpirationAlertTestAllExpirationAlert(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).ExpirationAlertTestRequest(expirationAlertTestRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Test All Expiration 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")
    expirationAlertTestRequest := *openapiclient.NewKeyfactorApiModelsAlertsExpirationExpirationAlertTestAllRequest() // KeyfactorApiModelsAlertsExpirationExpirationAlertTestAllRequest | Information about the expiration 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.ExpirationAlertApi.ExpirationAlertTestAllExpirationAlert(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).ExpirationAlertTestRequest(expirationAlertTestRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ExpirationAlertApi.ExpirationAlertTestAllExpirationAlert``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ExpirationAlertTestAllExpirationAlert`: KeyfactorApiModelsAlertsExpirationExpirationAlertTestResponse
    fmt.Fprintf(os.Stdout, "Response from `ExpirationAlertApi.ExpirationAlertTestAllExpirationAlert`: %v\n", resp)
}

Path Parameters

Other Parameters

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

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

Return type

KeyfactorApiModelsAlertsExpirationExpirationAlertTestResponse

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]

ExpirationAlertTestExpirationAlert

KeyfactorApiModelsAlertsExpirationExpirationAlertTestResponse ExpirationAlertTestExpirationAlert(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).ExpirationAlertTestRequest(expirationAlertTestRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Test an Expiration 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")
    expirationAlertTestRequest := *openapiclient.NewKeyfactorApiModelsAlertsExpirationExpirationAlertTestRequest() // KeyfactorApiModelsAlertsExpirationExpirationAlertTestRequest | Information about the expiration 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.ExpirationAlertApi.ExpirationAlertTestExpirationAlert(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).ExpirationAlertTestRequest(expirationAlertTestRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ExpirationAlertApi.ExpirationAlertTestExpirationAlert``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ExpirationAlertTestExpirationAlert`: KeyfactorApiModelsAlertsExpirationExpirationAlertTestResponse
    fmt.Fprintf(os.Stdout, "Response from `ExpirationAlertApi.ExpirationAlertTestExpirationAlert`: %v\n", resp)
}

Path Parameters

Other Parameters

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

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

Return type

KeyfactorApiModelsAlertsExpirationExpirationAlertTestResponse

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]