docs: clarify API routing (and with --web.external-url) #1918
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adamdecaf
force-pushed
the
docs-clarify-api-routes
branch
from
59627a7
to
b305078
Compare
adamdecaf
force-pushed
the
docs-clarify-api-routes
branch
from
b305078
to
2b08d2f
Compare
|
Thanks. I've updated after your suggestions. |
README.md
Outdated
|
|
||
| With the default config, endpoints are accessed under a `/api/v1` or `/api/v2` prefix. | ||
| The v2 `/status` endpoint would be `/api/v2/status`. If `--web.route-prefix` is set then API routes are | ||
| prefixed with that as well, so `--web.route-prefix=https://int.company.com/alertmanager/` would |
There was a problem hiding this comment.
It'd just be /alertmanager/ for this flag.
adamdecaf
force-pushed
the
docs-clarify-api-routes
branch
from
2b08d2f
to
e2423d5
Compare
Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
adamdecaf
force-pushed
the
docs-clarify-api-routes
branch
from
e2423d5
to
4440caa
Compare
|
Fixed and rebased. |
mxinden
approved these changes
Jun 11, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I couldn't find a reference for determining API routes on the readme, after some trial and error I found out what worked.