Updated Api (markdown)

master
jricher 2014-10-08 20:16:05 -07:00
parent 17390d42b3
commit 2ab72bdf1c
1 changed files with 15 additions and 0 deletions

15
Api.md

@ -986,3 +986,18 @@ Deletes the refresh token identified by {id}. The given {id} must point to a tok
Returns an HTTP 200 on success.
## Data
The data API is used for exporting and importing data to facilitate upgrades and server cloning.
### GET /api/data
*Requires __ROLE_ADMIN__ access.*
Returns an `application/json` object representing the current running state of the server, including all tokens, authorizations, clients, scopes, whitelists, blacklists, and grants. The format and content of this varies depending on the API version.
### POST /api/data
*Requires __ROLE_ADMIN__ access.*
Body contains an `application/json` object representing the state of the server to import, including all tokens, authorizations, clients, scopes, whitelists, blacklists, and grants. The format and content of this varies depending on the API version. Newer API versions will be able to import exports from older API versions, facilitating upgrades.