From 138f84d80ec2e52f3eb890e9ba70fbf004c2618b Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Sat, 18 Apr 2015 22:39:43 -0700 Subject: [PATCH] website: mostly complete API --- website/source/docs/http/sys-audit.html.md | 107 ++++++++++++++++++++ website/source/docs/http/sys-policy.html.md | 91 +++++++++++++++++ website/source/docs/http/sys-renew.html.md | 38 +++++++ website/source/docs/http/sys-revoke.html.md | 29 ++++++ 4 files changed, 265 insertions(+) create mode 100644 website/source/docs/http/sys-audit.html.md create mode 100644 website/source/docs/http/sys-policy.html.md create mode 100644 website/source/docs/http/sys-renew.html.md create mode 100644 website/source/docs/http/sys-revoke.html.md diff --git a/website/source/docs/http/sys-audit.html.md b/website/source/docs/http/sys-audit.html.md new file mode 100644 index 0000000000..349920098c --- /dev/null +++ b/website/source/docs/http/sys-audit.html.md @@ -0,0 +1,107 @@ +--- +layout: "http" +page_title: "HTTP API: /sys/audit" +sidebar_current: "docs-http-audits-audits" +description: |- + The `/sys/audit` endpoint is used to enable and disable audit backends. +--- + +# /sys/audit + +## GET + +
+
Description
+
+ Lists all the available policies. +
+ +
Method
+
GET
+ +
Parameters
+
+ None +
+ +
Returns
+
+ +``` +{ + "file": { + "type: "file", + "description: "Store logs in a file", + "options": { + "path": "/var/log/file" + } + } +} +``` +
+
+ +## PUT + +
+
Description
+
+ Enable an audit backend. +
+ +
Method
+
PUT
+ +
URL
+
`/sys/audit/`
+ +
Parameters
+
+
    +
  • + type + required + The type of the audit backend. +
    • +
  • + description + optional + A description of the audit backend for operators. +
    • +
  • + options + optional + An object of options to configure the backend. This is + dependent on the backend type. Please consult the documentation + for the backend type you intend to use. +
    • +
+
+ +
Returns
+
`204` response code. +
+
+ +## DELETE + +
+
Description
+
+ Disable the given audit backend. +
+ +
Method
+
DELETE
+ +
URL
+
`/sys/audit/`
+ +
Parameters
+
None +
+ +
Returns
+
`204` response code. +
+
diff --git a/website/source/docs/http/sys-policy.html.md b/website/source/docs/http/sys-policy.html.md new file mode 100644 index 0000000000..b45886fead --- /dev/null +++ b/website/source/docs/http/sys-policy.html.md @@ -0,0 +1,91 @@ +--- +layout: "http" +page_title: "HTTP API: /sys/policy" +sidebar_current: "docs-http-auth-policy" +description: |- + The `/sys/policy` endpoint is used to manage ACL policies in Vault. +--- + +# /sys/policy + +## GET + +
+
Description
+
+ Lists all the available policies. +
+ +
Method
+
GET
+ +
Parameters
+
+ None +
+ +
Returns
+
+ +``` +{ + "policies": ["root", "deploy"] +} +``` +
+
+ +## PUT + +
+
Description
+
+ Add or update a policy. Once a policy is updated, it takes effect + immediately to all associated users. +
+ +
Method
+
PUT
+ +
URL
+
`/sys/policy/`
+ +
Parameters
+
+
    +
  • + rules + required + The policy document. +
    • +
+
+ +
Returns
+
`204` respons code. +
+
+ +## DELETE + +
+
Description
+
+ Delete the policy with the given name. This will immediately + affect all associated users. +
+ +
Method
+
DELETE
+ +
URL
+
`/sys/policy/`
+ +
Parameters
+
None +
+ +
Returns
+
`204` respons code. +
+
diff --git a/website/source/docs/http/sys-renew.html.md b/website/source/docs/http/sys-renew.html.md new file mode 100644 index 0000000000..e794ab3fd4 --- /dev/null +++ b/website/source/docs/http/sys-renew.html.md @@ -0,0 +1,38 @@ +--- +layout: "http" +page_title: "HTTP API: /sys/renew" +sidebar_current: "docs-http-lease-renew" +description: |- + The `/sys/renew` endpoint is used to renew secrets. +--- + +# /sys/renew + +
+
Description
+
+ Renew a secret, requesting to extend the lease. +
+ +
Method
+
PUT
+ +
URL
+
`/sys/renew/`
+ +
Parameters
+
+
    +
  • + increment + optional + A requested amount of time in seconds to extend the lease. + This is advisory. +
    • +
+
+ +
Returns
+
A secret structure. +
+
diff --git a/website/source/docs/http/sys-revoke.html.md b/website/source/docs/http/sys-revoke.html.md new file mode 100644 index 0000000000..72892dda7f --- /dev/null +++ b/website/source/docs/http/sys-revoke.html.md @@ -0,0 +1,29 @@ +--- +layout: "http" +page_title: "HTTP API: /sys/revoke" +sidebar_current: "docs-http-lease-revoke" +description: |- + The `/sys/revoke` endpoint is used to revoke secrets. +--- + +# /sys/revoke + +
+
Description
+
+ Revoke a secret immediately. +
+ +
Method
+
PUT
+ +
URL
+
`/sys/revoke/`
+ +
Parameters
+
None
+ +
Returns
+
A `204` response code. +
+