Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
naman108 committed Feb 1, 2021
2 parents ba64ba4 + 7cbdce6 commit 45a2f5c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
6 changes: 4 additions & 2 deletions REST_APIDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,14 @@ Authorization: Bearer [YOUR_API_KEY]

> you need to use the string 'Bearer' before your API KEY
a valid key is generated from FTS' [CLI](https://github.com/FreeTAKTeam/FreeTAKServer-User-Docs/blob/main/docs/docs/CLI.md) and stored into the DB.
a valid key is generated from FTS' [CLI](https://github.com/FreeTAKTeam/FreeTAKServer-User-Docs/blob/main/docs/docs/CLI.md) or, since 1.4 also from the Web UI, and stored into the DB.
to add an API user in the CLI type
```
add_api_user
```
see CLI help for details
see CLI help for details.
To create a API TOKEN using the Web UI, go the User section.

to consume the API you need to request a key to your FTS admin.

the following is a key non working example
Expand Down
8 changes: 4 additions & 4 deletions REST_API_InternalDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -579,7 +579,7 @@ return JSON data containing the following information regarding current checklis
"id": "111-111-111",
"address": "127.0.0.1",
"port": "9000",
"fallback": "federation 2",
"fallBack": "federation 2",
"status": "Disabled",
"reconnectInterval": "32",
"maxRetries": "15",
Expand All @@ -599,7 +599,7 @@ create a new federation configuration
"name": "federation 1",
"address": "127.0.0.1",
"port": "9000",
"fallback": "federation 2",
"fallBack": "federation 2",
"status": "Disabled",
"reconnectInterval": "32",
"maxRetries": "15"
Expand Down Expand Up @@ -630,7 +630,7 @@ modify an existing federation configuration
{
"id": "111-111-111",
"name": "new federation 1",
"fallback": "new fallback",
"fallBack": "new fallback",
"status": "Enabled",
"reconnectInterval": "15",
"maxRetries": "10"
Expand All @@ -643,4 +643,4 @@ modify an existing federation configuration
* fallback(optional): name of new fallback
* status(optional): new status of connection
* reconnectInterval(optional): new reconnect interval
* maxRetries(optional): new maximum number of retries
* maxRetries(optional): new maximum number of retries
Binary file added docs/FTS UI Documention.pdf
Binary file not shown.

0 comments on commit 45a2f5c

Please sign in to comment.