From f32c6f81ec92db6dda4a08a28cb3ac4682653ace Mon Sep 17 00:00:00 2001 From: Lingxian Kong Date: Mon, 26 Aug 2019 15:45:28 +1200 Subject: [PATCH] Filtering description for backup API Story: #2006433 Task: #36344 Change-Id: I044b804e2ebdc6ecf545cb802114c5b774bb0645 --- api-ref/source/backups.inc | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/api-ref/source/backups.inc b/api-ref/source/backups.inc index 9fb4f4604e..4b35ea0584 100644 --- a/api-ref/source/backups.inc +++ b/api-ref/source/backups.inc @@ -12,7 +12,13 @@ List database backups .. rest_method:: GET /v1.0/{accountId}/backups -List all database backups information for a tenant. +List all database backups information for a project. You can filter results by +using query string parameters. The following filters are supported: + +- ``instance_id={instance_id}`` - Return the list of backups for a particular + database instance. +- ``all_projects`` - Return the list of backups for all the projects, this is + admin only param by default. Normal response codes: 200 @@ -65,7 +71,8 @@ List database backups for an instance .. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/backups -List all database backups for the specified instance. +List all database backups for the specified instance. This is equivalent to +``GET /v1.0/{accountId}/backups?instance_id={instanceId}``. Normal response codes: 200