Documentation
¶
Index ¶
- Constants
- func DeleteExecution(ctx context.Context, h *api.HTTPAPI, executionID string) (models.SuccessIDResponse, error)
- func GetExecutionReport(ctx context.Context, h *api.HTTPAPI, executionID string) (models.GetExecutionResponse, error)
- func GetExecutionStepReport(ctx context.Context, h *api.HTTPAPI, executionID string) ([]models.ExecutionStepDetections, error)
- func GetExecutions(ctx context.Context, h *api.HTTPAPI, opts ExecutionOpts) (models.ListWithCount[models.GetExecutionResponse], error)
- type ExecutionOpts
Constants ¶
View Source
const ExecutionsV2URI = "/api/v2/executions"
ExecutionsV2URI is the endpoint for the executions API
Variables ¶
This section is empty.
Functions ¶
func DeleteExecution ¶
func DeleteExecution(ctx context.Context, h *api.HTTPAPI, executionID string) (models.SuccessIDResponse, error)
DeleteExecution deletes an execution by ID
func GetExecutionReport ¶
func GetExecutionReport(ctx context.Context, h *api.HTTPAPI, executionID string) (models.GetExecutionResponse, error)
GetExecutionReport retrieves a detailed execution report by ID
func GetExecutionStepReport ¶ added in v1.1.0
func GetExecutions ¶
func GetExecutions(ctx context.Context, h *api.HTTPAPI, opts ExecutionOpts) (models.ListWithCount[models.GetExecutionResponse], error)
GetExecutions retrieves executions from the API with the given options
Types ¶
type ExecutionOpts ¶
type ExecutionOpts struct {
Size int `json:"size"`
Offset int `json:"offset"`
Order string `json:"order"`
Name string `json:"name,omitempty"`
DateBefore time.Time `json:"date_before,omitempty"`
DateAfter time.Time `json:"date_after,omitempty"`
AssetIDs []string `json:"asset_id,omitempty"`
Hostnames []string `json:"hostname,omitempty"`
ChainIDs []string `json:"chain_id,omitempty"`
AttackIDs []string `json:"attack_id,omitempty"`
ExecutionType []string `json:"execution_type,omitempty"`
Status string `json:"status,omitempty"`
}
ExecutionOpts represents options for listing executions
Click to show internal directories.
Click to hide internal directories.