summaryrefslogtreecommitdiffstats
path: root/API.md
diff options
context:
space:
mode:
authorSimo Sorce <simo@redhat.com>2015-04-08 09:51:32 -0400
committerSimo Sorce <simo@redhat.com>2015-04-08 09:51:32 -0400
commit3ad95956864a8b8727dc3661e208e04b688baf8e (patch)
tree16f4f9372a99cd80a204e58397b16bcb3d1612c2 /API.md
parent575efc8bd229cfa5ef7d73c4b53c1e27f6f267d5 (diff)
downloadcustodia-3ad95956864a8b8727dc3661e208e04b688baf8e.tar.gz
custodia-3ad95956864a8b8727dc3661e208e04b688baf8e.tar.xz
custodia-3ad95956864a8b8727dc3661e208e04b688baf8e.zip
Allow to filter by keytype on key GET
Diffstat (limited to 'API.md')
-rw-r--r--API.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/API.md b/API.md
index a2f7cba..b7395ab 100644
--- a/API.md
+++ b/API.md
@@ -53,11 +53,15 @@ Getting keys
A GET operation with the name of the key:
GET /secrets/name/of/key
+A query parameter named 'type' can be provided, in that case the key is
+returned only if it matches the requested type.
+
Returns:
- 200 and a JSON formatted key in case of success.
- 401 if authentication is necessary
- 403 if access to the key is forbidden
- 404 if no key was found
+- 406 not acceptable, key exists but does not match type requested
Storing keys