Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Commit

Permalink
Update API.md with /v1/metadata changes
Browse files Browse the repository at this point in the history
  • Loading branch information
mayitbeegh authored Jun 12, 2020
1 parent 977b896 commit 06daacd
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion API.md
Original file line number Diff line number Diff line change
Expand Up @@ -1431,7 +1431,7 @@ SDBs under different categories have no functional difference. They are simply a

# Group Admin Endpoints

## SDB Metadata [/v1/metadata?limit={limit}&offset={offset}]
## SDB Metadata [/v1/metadata?limit={limit}&offset={offset}&sdbName={sdbName}]

### Get metadata [GET]

Expand All @@ -1442,6 +1442,7 @@ This endpoint does not return any secret data but can be used by Cerberus admins
+ Parameters
+ limit (number) - OPTIONAL: The number of records to include in the metadata result. Defaults to 100
+ offset (number) - OPTIONAL: The offset to use when paginating records. Defaults to 0
+ sdbName (string) - OPTIONAL: The name of the SDB.

+ Request

Expand All @@ -1463,6 +1464,7 @@ This endpoint does not return any secret data but can be used by Cerberus admins
"total_sdbcount": 3,
"safe_deposit_box_metadata": [
{
"id": "sdb id",
"name": "dev demo",
"path": "app/dev-demo/",
"category": "Applications",
Expand All @@ -1480,6 +1482,7 @@ This endpoint does not return any secret data but can be used by Cerberus admins
}
},
{
"id": "sdb id 2",
"name": "nike dev foo bar",
"path": "app/nike-dev-foo-bar/",
"category": "Applications",
Expand All @@ -1495,6 +1498,7 @@ This endpoint does not return any secret data but can be used by Cerberus admins
"iam_role_permissions": {}
},
{
"id": "sdb id 3",
"name": "IaM W d WASD",
"path": "shared/iam-w-d-wasd/",
"category": "Shared",
Expand Down

0 comments on commit 06daacd

Please sign in to comment.