Uh oh!
There was an error while loading. Please reload this page.
docs: document calling the sandbox API from outside the cluster - #399
Merged
Conversation
Uh oh!
There was an error while loading. Please reload this page.
Contributor
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or 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
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
The sandbox docs mentioned you could use the SDK from outside the sandbox cluster with an API token, but never said what URL to point it at. This fills that in: set
PORTER_SANDBOX_BASE_URLtohttps://dashboard.porter.run/api/v2/alpha/projects/<project-id>/clusters/<cluster-id>andPORTER_SANDBOX_API_KEYto a Porter API token.The getting-started page gets the full setup (env exports plus how to find the project and cluster IDs), the SDK quickstarts get a one-liner linking back to it, and the reference pages now document the env var fallbacks on the
api_key/base_urlconstructor options.