---
title: "Checkout a branch or ref"
method: POST
path: "/api/projects/{projectId}/workspaces/{workspaceId}/git/checkout"
tags: ["Git"]
---

# Checkout a branch or ref

`POST /api/projects/{projectId}/workspaces/{workspaceId}/git/checkout`

Checkout a branch or ref. Accepts a JSON request body when defined and returns the resulting resource or action status.

## Path parameters

- `projectId` string, required
- `workspaceId` string, required

## Request body

- GitCheckoutRequest — git Checkout Request payload accepted by the API.
  - `ref` string, required — ref value for the git Checkout Request object.

## Response `200`

Checkout result

- MessageResponse — Generic action result message used by endpoints that do not return a dedicated resource.
  - `message` string — Human-readable status or error message.
  - `status` string — Current status value.
  - `success` boolean — Whether the requested action succeeded.

---

[API](https://skmtc.dev/ibuildthecloud/apis/discobot-server-api.md) · [All operations](https://skmtc.dev/ibuildthecloud/apis/discobot-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ibuildthecloud/discobot-server-api/revisions/4de3fcd6be56/schema)