List databases from an RDS backup

Retrieves a list of RDS databases from an RDS backup.

Path Parameters

backup_id string required
Performs the operation on the backup with the specified ID.

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).
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:

Field Filter Condition Description
name $begins_with Prefix of the RDS database name
For more information about filtering, refer to the Filtering section of this guide.

Field	Filter Condition	Description
name	$begins_with	Prefix of the RDS database name

Responses

200
default

Success

application/api.clumio.backup-aws-rds-resource-databases=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
name string
The name of the database.
_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.
_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.
_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.
limit int64
The maximum number of items displayed per page in the response.
start string
The page token used to get this response.

{
  "_embedded": {
    "items": [
      {
        "name": "string"
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "limit": 0,
  "start": "string"
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

GET /backups/aws/rds-resources/:backup_id/databases

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

backup_id — path required

limit — query

start — query

filter — query

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

List databases from an RDS backup​

Authorization

Request

List databases from an RDS backup