Checkout workspace ref

Set the workspace to follow a different branch or commit (checkout). Currently supports only moving to a branch with an identical commit as the workspace’s current branch, or moving to any branch/commit if the workspace has no working changes.

POST /repos/{repo_id}/workspaces/{workspace_id}/checkout

Workspace checkout ref

cURL

curl --request POST \
  --url https://api.diversion.dev/v0/repos/{repo_id}/workspaces/{workspace_id}/checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref_id": "<string>"
}
'

409

{
  "status": 403,
  "detail": "User not authorized to perform the requested action on the resource",
  "title": "<string>",
  "type": "<string>"
}

Authorizations

Authorization · string · header · required

This API uses OAuth 2 with the implicit grant flow

Path Parameters

repo_id · string · required

The repo ID of the repository. Repo name can be used instead of the ID, but usage of ID for permanent linking and API requests is preferred.

Required string length: 3 - 128

Example:

"example_id"

workspace_id · string · required

The repo ID of the workspace.

Required string length: 3 - 128

Example:

"example_id"

Body

application/json

Properties to modify in an existing workspace

ref_id · string · required

A branch or commit ID to point the workspace onto

Response

204

Request completed successfully