Sandbox CLIs

Upsert CLI connection

Changed on

Set or replace a project's CLI connection credentials (e.g. the kubectl CLI's KUBECONFIG_CONTENTS). The credentials are tested in a read-only ephemeral sandbox first unless skipTest is set: a failed test saves nothing and is refused with reason: connection_test_failed, and a passed test records the connection as verified in the same step. Values are encrypted server-side and never returned. Requires write access to the target project.

post/sandbox-clis/config

Request

  • Base URL: https://api.sazabi.com/v1
  • URL: https://api.sazabi.com/v1/sandbox-clis/config
  • Auth: none declared

Request body

projectIdstring uuid

Project to configure. Required for organization-scoped keys; auto-filled from a project-scoped key when omitted.

cliTypestring required

CLI type identifier (e.g. kubectl, aws, github).

skipTestboolean

Save without running the connection test first. Nothing is confirmed, so the connection is not marked verified and an existing needs-attention status is kept.

Response

OK

projectIdstring uuid required

Project the CLI connection was written to.

idstring uuid required

Connection ID of the stored connection row.

cliTypestring required

CLI type that was upserted.

envVarKeysstring[] required

Env var key names now stored for this sandbox CLI. Values are never returned.

connectionTest'passed' | 'skipped' | 'inconclusive' required

What the save learned about the stored credentials: passed (the connection test passed; the connection is verified when the CLI supports saved-credential checks), skipped (saved with skipTest), or inconclusive (the test sandbox could not run, so the credentials were saved untested).

Changes

  • 5f4a1feb193aRevision changes
    • info

      added the required property to the response with the status

  • 752040c39373Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status