Checkout a branch
POST /v1/sandbox/{sandboxID}/git/checkout-branch
POST
/v1/sandbox/{sandboxID}/git/checkout-branch
Switch to a different branch. Optionally create it if it doesn’t exist.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” sandboxID
required
string
Unique sandbox identifier.
Request Body required
Section titled “Request Body required ”object
path
required
Path to the git repository.
string
branch
required
Branch name to checkout.
string
create
Create the branch if it doesn’t exist.
boolean
Responses
Section titled “ Responses ”Branch checked out.
object
output
required
Command output text.
string
exit_code
required
Exit code of the git command.
integer format: int32
Bad request – validation error.
object
message
required
Summary message, e.g. “Invalid request”.
string
errors
required
Array<object>
object
field
required
JSON field name that failed validation (e.g. “path”, “command”).
string
error
required
Human-readable description of the validation failure.
string
Unauthorized – invalid or missing API key.
object
message
required
Human-readable error message.
string