\IssuedAlertApi

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

Method	HTTP request	Description
CreateAlertsIssued	POST /Alerts/Issued	Add a issued alert
DeleteAlertsIssuedById	DELETE /Alerts/Issued/{id}	Delete a issued alert
GetAlertsIssued	GET /Alerts/Issued	Gets all issued alerts according to the provided filter and output parameters
GetAlertsIssuedById	GET /Alerts/Issued/{id}	Get a issued alert
GetAlertsIssuedSchedule	GET /Alerts/Issued/Schedule	Get the schedule for issued alerts
UpdateAlertsIssued	PUT /Alerts/Issued	Edit a issued alert
UpdateAlertsIssuedSchedule	PUT /Alerts/Issued/Schedule	Edit schedule

CreateAlertsIssued

AlertsIssuedIssuedAlertDefinitionResponse NewCreateAlertsIssuedRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsIssuedIssuedAlertCreationRequest(alertsIssuedIssuedAlertCreationRequest).Execute()

Add a issued alert

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)
    alertsIssuedIssuedAlertCreationRequest := *openapiclient.NewAlertsIssuedIssuedAlertCreationRequest("DisplayName_example", "Subject_example", "Message_example") // AlertsIssuedIssuedAlertCreationRequest | Information for the new alert (optional)

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

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateAlertsIssuedRequest 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
alertsIssuedIssuedAlertCreationRequest	AlertsIssuedIssuedAlertCreationRequest	Information for the new alert

Return type

AlertsIssuedIssuedAlertDefinitionResponse

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]

DeleteAlertsIssuedById

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

Delete a issued alert

Example

package main

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

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

Other Parameters

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

GetAlertsIssued

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

Gets all issued alerts 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 |  (optional)
    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.IssuedAlertApi.NewGetAlertsIssuedRequest(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 `IssuedAlertApi.GetAlertsIssued``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAlertsIssued`: []AlertsIssuedIssuedAlertDefinitionResponse
    fmt.Fprintf(os.Stdout, "Response from `IssuedAlertApi.GetAlertsIssued`: %v\n", resp)
}

Path Parameters

Other Parameters

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

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

Return type

[]AlertsIssuedIssuedAlertDefinitionResponse

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]

GetAlertsIssuedById

AlertsIssuedIssuedAlertDefinitionResponse NewGetAlertsIssuedByIdRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Get a issued alert

Example

package main

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

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

Other Parameters

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

Name	Type	Description	Notes

Return type

AlertsIssuedIssuedAlertDefinitionResponse

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]

GetAlertsIssuedSchedule

AlertsAlertScheduleAlertScheduleResponse NewGetAlertsIssuedScheduleRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Get the schedule for issued alerts

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)

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

Path Parameters

Other Parameters

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

AlertsAlertScheduleAlertScheduleResponse

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]

UpdateAlertsIssued

AlertsIssuedIssuedAlertDefinitionResponse NewUpdateAlertsIssuedRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsIssuedIssuedAlertUpdateRequest(alertsIssuedIssuedAlertUpdateRequest).Execute()

Edit a issued alert

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)
    alertsIssuedIssuedAlertUpdateRequest := *openapiclient.NewAlertsIssuedIssuedAlertUpdateRequest("DisplayName_example", "Subject_example", "Message_example") // AlertsIssuedIssuedAlertUpdateRequest | Information for the issued alert (optional)

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

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUpdateAlertsIssuedRequest 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
alertsIssuedIssuedAlertUpdateRequest	AlertsIssuedIssuedAlertUpdateRequest	Information for the issued alert

Return type

AlertsIssuedIssuedAlertDefinitionResponse

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]

UpdateAlertsIssuedSchedule

AlertsAlertScheduleAlertScheduleResponse NewUpdateAlertsIssuedScheduleRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsAlertScheduleAlertScheduleRequest(alertsAlertScheduleAlertScheduleRequest).Execute()

Edit schedule

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)
    alertsAlertScheduleAlertScheduleRequest := *openapiclient.NewAlertsAlertScheduleAlertScheduleRequest() // AlertsAlertScheduleAlertScheduleRequest |  (optional)

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

Path Parameters

Other Parameters

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

Return type

AlertsAlertScheduleAlertScheduleResponse

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

IssuedAlertApi.md

Latest commit

History

IssuedAlertApi.md

File metadata and controls

\IssuedAlertApi

CreateAlertsIssued

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteAlertsIssuedById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAlertsIssued

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAlertsIssuedById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAlertsIssuedSchedule

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateAlertsIssued

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateAlertsIssuedSchedule

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers