status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-01-11 14:24:39 +00:00
Code Issues Projects Releases Wiki Activity

Add links for session endpoints

Browse Source
This commit is contained in:
Brian Lalor 2014-10-23 07:56:28 -04:00
parent 03be420bce
commit 8d6b8f4309
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
website/source/docs/agent/http.html.markdown
View File

@ -966,15 +966,15 @@ This endpoint supports blocking queries and all consistency modes.
The Session endpoints are used to create, destroy and query sessions. The Session endpoints are used to create, destroy and query sessions.
The following endpoints are supported: The following endpoints are supported:
* /v1/session/create: Creates a new session * [`/v1/session/create`](#session_create): Creates a new session
* /v1/session/destroy/\<session\>: Destroys a given session * [`/v1/session/destroy/\<session\>`](#session_destroy): Destroys a given session
* /v1/session/info/\<session\>: Queries a given session * [`/v1/session/info/\<session\>`](#session_info): Queries a given session
* /v1/session/node/\<node\>: Lists sessions belonging to a node * [`/v1/session/node/\<node\>`](#session_node): Lists sessions belonging to a node
* /v1/session/list: Lists all the active sessions * [`/v1/session/list`](#session_list): Lists all the active sessions
All of the read session endpoints supports blocking queries and all consistency modes. All of the read session endpoints supports blocking queries and all consistency modes.
### /v1/session/create ### <a name="session_create"></a> /v1/session/create
The create endpoint is used to initialize a new session. The create endpoint is used to initialize a new session.
There is more documentation on sessions [here](/docs/internals/sessions.html). There is more documentation on sessions [here](/docs/internals/sessions.html).
@ -1020,7 +1020,7 @@ The return code is 200 on success, along with a body like:
This is used to provide the ID of the newly created session. This is used to provide the ID of the newly created session.
### /v1/session/destroy/\<session\> ### <a name="session_destroy"></a> /v1/session/destroy/\<session\>
The destroy endpoint is hit with a PUT and destroys the given session. The destroy endpoint is hit with a PUT and destroys the given session.
By default the local datacenter is used, but the "?dc=" query parameter By default the local datacenter is used, but the "?dc=" query parameter
@ -1029,7 +1029,7 @@ be provided after the slash.
The return code is 200 on success. The return code is 200 on success.
### /v1/session/info/\<session\> ### <a name="session_info"></a> /v1/session/info/\<session\>
This endpoint is hit with a GET and returns the session information This endpoint is hit with a GET and returns the session information
by ID within a given datacenter. By default the datacenter of the agent is queried, by ID within a given datacenter. By default the datacenter of the agent is queried,
@ -1055,7 +1055,7 @@ It returns a JSON body like this:
If the session is not found, null is returned instead of a JSON list. If the session is not found, null is returned instead of a JSON list.
This endpoint supports blocking queries and all consistency modes. This endpoint supports blocking queries and all consistency modes.
### /v1/session/node/\<node\> ### <a name="session_node"></a> /v1/session/node/\<node\>
This endpoint is hit with a GET and returns the active sessions This endpoint is hit with a GET and returns the active sessions
for a given node and datacenter. By default the datacenter of the agent is queried, for a given node and datacenter. By default the datacenter of the agent is queried,
@ -1081,7 +1081,7 @@ It returns a JSON body like this:
This endpoint supports blocking queries and all consistency modes. This endpoint supports blocking queries and all consistency modes.
### /v1/session/list ### <a name="session_list"></a> /v1/session/list
This endpoint is hit with a GET and returns the active sessions This endpoint is hit with a GET and returns the active sessions
for a given datacenter. By default the datacenter of the agent is queried, for a given datacenter. By default the datacenter of the agent is queried,