Switch the caller's session to a branch (git checkout)

POST

/api/workspaces/{workspaceId}/repo/checkout

curl --request POST \
  --url http://localhost:8080/api/workspaces/example/repo/checkout \
  --header 'Content-Type: application/json' \
  --cookie auth_session=<auth_session> \
  --data '{ "branch": "example", "create": true }'

• Configured API base URL

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Request Body

Media typeapplication/json

object

branch

required

string

>= 1 characters <= 200 characters

create

boolean

Example ^generated

{
  "branch": "example",
  "create": true
}

Responses

2XX

Successful response

Media typeapplication/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}