argos/docs/api.md
2023-12-14 15:20:46 +01:00

15 lines
536 B
Markdown

# The HTTP API
Argos exposes a website and an API. The website is available at "/" and the API at "/api".
## Authentication
To access the API, you need to pass an authentication token in the `Authorization` header, as defined in the configuration file. It's a Bearer token, so you need to pass it as a header like this :
```
"Authorization": "Bearer " + token
```
## Endpoints
You can also have access to the Swagger API documentation at `https://<argos-url>/docs`, and the ReDoc documentation at `https://<argos-url>/redoc`.