Skip to main content

List Action Plans

POST 
/apm/api/v1/action-plan

List all Action Plans for a tenant ordered by criticality desc. Offset for pagination.You must have ActionPlanOverview_READ permission to access this endpoint. Rate limit 10/sec.

Request​

Header Parameters

    x-redlock-auth stringrequired

    Authorize using Authentication token

    Example: jwt token

Body

    limit int64
    nextPageToken string
    filters object[]

    List of filters that can be applied for the API

  • Array [
    • name ActionPlanFilter (string)

    Possible values: [status, assignee, finding.type, id, business.criticality]

    operator string

    Only allowed operator for the filter is '='

    value string

    Value for the applied filter

  • ]
    • sortBy object
    name SortField

    Possible values: [criticality, alertCount, assetCount]

    order SortDirection

    Possible values: [desc, asc]

Responses​

OK

Schema
    lastRunTs int64
    totalCount int64
    value object[]
  • Array [
    • name string
    id string
    status string
    alertCount int64
    assetCount int64
    findingTypes string[]
    impactfulAssetId string
    impactfulAssetType int64
    criticality string
    primaryAssetStatus string
    summary string
    assignee string
    thumbsUpDown string

    Possible values: [down, up, none]

    thumbsDownReasons ThumbsDownReason (string)[]
    thumbsDownDescription string
    countByPolicyType object[]
  • Array [
    • policyType string
    count int64
  • ]
    • countByPolicyCategory object[]
  • Array [
    • policyCategory string
    count int64
  • ]
    • createdAtTs int64
    feedbackLastUpdatedTs int64
    lastUpdatedTs int64
    lastUpdatedBy string
  • ]
    • nextPageToken string
Loading...