Skip to content

Commit

Permalink
update postman collection
Browse files Browse the repository at this point in the history
  • Loading branch information
blade committed Mar 28, 2024
1 parent 4a62acf commit 49f1696
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions docs/api-endpoints.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

The Gateway Server currently exposes all its API endpoints in form of HTTP endpoints. Note, we can move this to Swagger in the future if our API endpoints become more complex.

Postman collection can be found [here](https://www.postman.com/dark-shadow-851601/workspace/os-gateway/collection/27302708-537f3ba3-3193-4290-98d0-0d5836988a2f)

`x-api-key` is an api key set by the gateway operator to transmit internal private data

| Endpoint | HTTP METHOD | Description | HEADERS | Request Parameters |
|---------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------------------------------------|
| `/relay/{chain_id}` | ANY | The main endpoint for your reverse proxy to send requests too | ANY | `{chain_id}` - Network identifier |
| `/metrics` | GET | Metadata on the gateway server performance for observability purposes | N/A | N/A |
| `/poktapps` | POST | Adds an existing app stake to the appstake database (not recommended due to security) | `x-api-key` | `private_key` - private key of app stake |
| `/poktapps` | DELETE | Removes an existing app stake from the appstake database (not recommended due to security) | `x-api-key` | `app_id` - id of the appstake |
| `/poktapps` | GET | A list of all the available app stakes | `x-api-key` | N/A |
| `/qosnodes` | GET | A list of nodes and public QoS state such as healthiness and last known error. This can be used to expose to node operators to improve visibility. | `x-api-key` | N/A |
| Endpoint | HTTP METHOD | Description | HEADERS | Request Parameters |
|----------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------------------------------------|
| `/relay/{chain_id}` | ANY | The main endpoint for your reverse proxy to send requests too | ANY | `{chain_id}` - Network identifier |
| `/metrics` | GET | Metadata on the gateway server performance for observability purposes | N/A | N/A |
| `/poktapps` | GET | A list of all the available app stakes | `x-api-key` | N/A |
| `/poktapps` | POST | Adds an existing app stake to the appstake database (not recommended due to security) | `x-api-key` | `private_key` - private key of app stake |
| `/poktapps/{app_id}` | DELETE | Removes an existing app stake from the appstake database (not recommended due to security) | `x-api-key` | `app_id` - id of the appstake |
| `/qosnodes` | GET | A list of nodes and public QoS state such as healthiness and last known error. This can be used to expose to node operators to improve visibility. | `x-api-key` | N/A |

0 comments on commit 49f1696

Please sign in to comment.