Skip to main content

List RDS database backups

Retrieves a list of RDS database backups.

Query Parameters
  • limit int64

    Limits the size of the response on each page to the specified number of items.

  • start string

    Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

  • sort string

    Returns the list of backups in the order specified. Set sort to the name of the sort field by which to sort in ascending order. To sort the list in reverse order, prefix the field name with a minus sign (-). Only one field may be sorted at a time.

    The following table lists the supported sort fields for this resource:

    Sort FieldDescription
    start_timestampSorts the backups in ascending timestamp order (oldest first). For example, ?sort=start_timestamp
    If a sort order is not specified, the individual rules are sorted by "start_timestamp" in descending timestamp order (newest first).
  • filter string

    Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

    FieldFilter ConditionDescription
    resource_id$eqFilter database backups whose database ID equal the specified string. For example, ?filter={"resource_id":{"$eq":"fdba79ed-502b-11fb-9bdc-83d528bd52dc"}}
    start_timestamp$lte, $gtFilter database backups whose start timestamp is "less than or equal to" or "greater than" a given timestamp. Represented in RFC-3339 format. For example, ?filter={"start_timestamp":{"$lte":"1985-04-12T23:20:50Z"}}
    For more information about filtering, refer to the Filtering section of this guide.
Responses

Success


Schema
  • _embedded object

    Embedded responses related to the resource.

  • items object[]

    A collection of requested items.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • list-aws-rds-resources-option-groups object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • restore-aws-rds-resource object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • restore-rds-record object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • account_native_id string

    The AWS-assigned ID of the account associated with this database at the time of backup.

  • aws_azs string[]

    The AWS availability zones associated with this database at the time of backup.

  • aws_region string

    The AWS region associated with this environment.

  • database_native_id string

    The AWS-assigned ID of the database at the time of backup.

  • engine string

    The AWS database engine at the time of backup.

  • engine_version string

    The aws database engine version at the time of backup.

  • expiration_timestamp string

    The timestamp of when this backup expires. Represented in RFC-3339 format.

  • id string

    The Clumio-assigned ID of the backup.

  • instances object[]

    The instances associated with a backup RDS resource.

  • class string

    The class of the RDS instance at the time of backup. Possible values include db.r5.2xlarge and db.t2.small. For a full list of possible values, refer to the Amazon documentation at https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html.

  • is_publicly_accessible boolean

    Determines whether the RDS instance had a public IP address in addition to the private IP address at the time of backup. For more information about the public access option, refer to the Amazon documentation at https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html.

  • name string

    The AWS-assigned name of the RDS instance at the time of backup.

  • kms_key_native_id string

    The AWS-assigned ID of the KMS key associated with this database at the time of backup.

  • migration_timestamp string

    The timestamp of when the migration was triggered. This field will be set only for migration granular backups. Represented in RFC-3339 format.

  • option_group_name string

    Option group name associated with the backed up RDS resource

  • resource_id string

    The Clumio-assigned ID of the database associated with this backup.

  • resource_type string

    The type of the RDS resource associated with this backup. Possible values include aws_rds_cluster and aws_rds_instance.

  • security_group_native_ids string[]

    The AWS-assigned IDs of the security groups associated with this RDS resource backup.

  • size int64

    The size of the RDS resource backup. Measured in bytes (B).

  • start_timestamp string

    The timestamp of when this backup started. Represented in RFC-3339 format.

  • subnet_group_name string

    The AWS-assigned name of the subnet group associated with this RDS resource backup.

  • tags object[]

    The AWS tags associated with the database at the time of backup.

  • key string

    The AWS-assigned tag key.

  • value string

    The AWS-assigned tag value.

  • type string

    The type of backup. Possible values include clumio_snapshot and granular_backup.

  • _links object

    URLs to pages related to the resource.

  • _first object

    The HATEOAS link to the first page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _last object

    The HATEOAS link to the last page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _next object

    The HATEOAS link to the next page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _prev object

    The HATEOAS link to the previous page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • current_count int64

    The number of items listed on the current page.

  • filter_applied string

    The filter used in the request. The filter includes both manually-specified and system-generated filters.

  • limit int64

    The maximum number of items displayed per page in the response.

  • start string

    The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").

  • total_count int64

    The total number of items, summed across all pages.

  • total_pages_count int64

    The total number of pages of results.

GET /backups/aws/rds-resources    

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
limit — query
start — query
sort — query
filter — query
curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources' \
-H 'Accept: application/api.clumio.backup-aws-rds-resources=v1+json' \
-H 'Authorization: Bearer <TOKEN>'