Skip to main content

Get Compliance Trend for Standard ID - POST

POST 
/compliance/posture/trend/:complianceId
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Returns a compliance posture summary that describes the passed/failed statistics trend for the specified compliance standard ID.

info

Replacement  Endpoint: Get Compliance Trend for Standard ID V2 - POST

The fields request body parameter allows you to request specific fields. These fields are separate from the filters you specify. The following are valid fields items.

  • cloud.account
  • account.group
  • cloud.region
  • cloud.type
  • policy.complianceStandard
  • policy.complianceRequirement
  • policy.complianceSection

The filters request body parameter enables you to narrow your request for alerts. See Get Compliance Overview Filters and Options for for an API request to list all the valid filters.

note

This endpoint will only be able to access data from the past 1 year. This change is implemented to optimize system performance and reduce data storage requirements of deprecated endpoints.

Request​

Path Parameters

    complianceId uuidrequired

    Compliance standard ID

Body

    detailed boolean

    Detailed

    fields string[]

    Array of specific fields to return

    filters object[]

    Filtering parameters.

    For filter names, refer to List Filters API.

    For filter values, refer to List filter suggestions.

    The only exception is resource.tagv2 filter name, provide filter value for it in the following format: "{"key":"'CustomerTagKey'","value":"'CustomerTagValue'"}"

  • Array [
    • name string

    Name

    operator string

    Possible values: [tag:yaml.org,2002:value =]

    Operator

    value string

    Value

  • ]
    • groupBy string[]

    For asset or data inventory only. Group returned items by cloud.type, cloud.service, cloud.region, cloud.account, and/or resource.type

    limit number

    Maximum number of items to return. When data is paginated, maximum number of items per page.The maximum cannot exceed 10,000. The default is 10,000.

    offset number

    The number of items to skip before selecting items to return. Default is zero

    pageToken string

    Setting this pagination Token to the nextPageToken from a response object returns the next page of data

    sortBy string[]

    Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively. Example sort properties are id:asc and timestamp:desc

    timeRange object

    See the Time Range Model for details.

    oneOf
    relativeTimeType string

    Possible values: [BACKWARD, FORWARD]

    Direction in which to count time. Default = BACKWARD

    type string
    value objectrequired

    Model for RelativeTimeDuration

    amount int32

    Number of time units

    unit string

    Possible values: [minute, hour, day, week, month, year]

    Time unit

Responses​

success

Schema
  • Array [
    • criticalSeverityFailedResources int64

    Number of scanned compliance resources whose highest policy failure is critical

    failedResources int64

    Number of failed scanned compliance resources

    highSeverityFailedResources int64

    Number of scanned compliance resources that failed high severity policies

    informationalSeverityFailedResources int64

    Number of scanned compliance resources whose highest policy failure is informational

    lowSeverityFailedResources int64

    Number of scanned compliance resources whose highest policy failure is low

    mediumSeverityFailedResources int64

    Number of scanned compliance resources whose highest policy failure is medium

    passedResources int64

    Number of passed scanned compliance resources

    timestamp int64

    Timestamp

    totalResources int64

    Total number of scanned compliance resources

  • ]
Loading...