Skip to content

REST API Getting Started documentation points to hosted API URL and localhost #3661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brandongregoryscott opened this issue May 27, 2025 · 0 comments

Comments

@brandongregoryscott
Copy link

brandongregoryscott commented May 27, 2025

Path: /documentation/getting-started/api

The curl example in Step 5 Get an access token for the Infisical API points to the hosted Infisical API (https://app.infisical.com/api/v1...), while Step 6 Fetch back secret points to a localhost URL, presumably for a self-hosted solution: http://localhost:8080/api/v3....

I would suggest keeping them consistent one way or the other (both pointing to the hosted API URL or both pointing to the self-hosted API URL). I assume the primary consumer reading these docs is trying out the hosted version, so it probably makes sense to use that URL, maybe with a callout underneath about swapping out the base API URL if you're running it locally or self-hosting.

One other point of feedback is a note about the workspaceId parameter that the /api/v3/secrets endpoint takes. I guessed that it takes the Project Id copied from Secret Managers > Example Project > Settings and that seems to work, but it was not obvious since the terminology differs (I didn't see Workspace noted anywhere in the UI)

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant