Skip to main content

List Policy template​

API to list policy templates

Path Parameters
  • accountId int64 required

    Cloud Rewind account ID.

  • projectId string required

    Cloud Rewind project ID.

Query Parameters
  • sort_by string

    Default value: name

    Specifies the Policy template property by which the results should be sorted.
    Allowed values:

    • name, cloud-type, frequency-type, time-zone
  • sort_order string

    Default value: asc

    Specifies the order in which the results should be sorted.
    Allowed values:

    • asc, desc
  • name string

    The policy templates are filtered by the name of the Policy Template.

  • cloud_type string

    Should be filtered by the Cloud type.
    Allowed values:

    • aws, azure, gcp
  • frequency_type string

    Should be filtered by the frequency type of the Policy template.
    Allowed values:

    • fifteen-minutes, thirty-minutes, hourly, two-hours, three-hours, four-hours, six-hours, eight-hours, twelve-hours, daily, weekly, monthly, yearly
  • time_zone string

    Should be filtered by the time zone of the Policy template.
    The value of this field must be a time zone name from the Tz database
    Example: America/New_York

  • filter_condition string

    Default value: or

    Specifies the filter condition to be applied to the results.
    Allowed values:

    • and, or
Header Parameters
  • Range string

    Default value: items=1-100

    Filter to specify the page range for paginated results. Format: items=startIndex-endIndex.

Responses

OK

Schema array
  • accountId int64

    Cloud Rewind account ID.

  • projectId string

    Cloud Rewind project ID.

  • id int64

    ID of the policy template.

  • name string

    Name of the policy template.

  • description string

    Description of the policy template.

  • frequencyType string

    AWS resource type for the policy template.

  • frequencyDetails object

    Details about the frequency configuration of the policy template

  • daysOfWeek string[]

    Days of the week

  • months string[]

    Months of the year

  • daysOfMonth int32[]

    Days of the month

  • hours int32[]

    Hours of the day

  • offset int32

    Delays the defined scheduled execution time (in minutes)

  • cloudType string

    Possible values: [aws, common, gcp, azure]

    Type of the cloud for the Policy template.

  • timeZone string

    Time zone for the policy template schedule

  • retentionCount int32

    Number of backups to retain

  • createdAt date-time

    Timestamp indicating when the policy template was created

  • updatedAt date-time

    Timestamp indicating when the policy template was last updated

Loading...