README.md

Executions

(Runbooks.Executions)

Overview

Available Operations

• Delete - Terminate a runbook execution

Delete

Terminates a runbook execution, preventing any further steps from being executed

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Runbooks.Executions.Delete(ctx, "<id>", "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
executionID	string	✔️	N/A
reason	string	✔️	The reason for terminating the runbook execution
opts	[]operations.Option	➖	The options for this request.

Response

*operations.DeleteRunbookExecutionResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*