---
title: "Create a new branch"
method: POST
path: "/groups/{groupId}/artifacts/{artifactId}/branches"
tags: ["Branches"]
---

# Create a new branch

`POST /groups/{groupId}/artifacts/{artifactId}/branches`

## Request

- The document declares no server URL.
- Auth: none declared

Creates a new branch for the artifact.  A new branch consists of metadata and a
list of versions.

This operation can fail for the following reasons:

* No artifact with this `groupId` and `artifactId` exists (HTTP error `404`)
* A branch with the given `branchId` already exists (HTTP error `409`)
* A server error occurred (HTTP error `500`)

## Request body

- CreateBranch
  - `description` string
  - `branchId` string, required: The ID of a single artifact branch.
  - `versions` Version[]

## Response `200`

Branch successfully created.

- BranchMetaData
  - `groupId` string, required: An ID of a single artifact group.
  - `artifactId` string, required: The ID of a single artifact.
  - `branchId` string, required: The ID of a single artifact branch.
  - `createdOn` string, date-time, required
  - `modifiedBy` string, required
  - `modifiedOn` string, date-time, required
  - `owner` string, required
  - `description` string
  - `systemDefined` boolean, required

## Other responses

- `401`: Common response for all operations that can return a `401` error indicating authentication is required.
- `403`: Common response for all operations that can return a `403` error indicating the user is authenticated but not authorized.
- `404`: Common response for all operations that can return a `404` error.
- `409`: Common response used when an input conflicts with existing data.
- `500`: Common response for all operations that can fail with an unexpected server error.

## Changes

- **2026-10-31** `ff9684af2aad`: 25 info
  - added the optional property `ruleViolation/causes/items/code` to the response with the `401` status
  - added the optional property `ruleViolation/causes/items/code` to the response with the `403` status
  - added the optional property `ruleViolation/causes/items/code` to the response with the `404` status
  - added the optional property `ruleViolation/causes/items/code` to the response with the `409` status
  - …21 more
- **2026-10-29** `f17f5df4e79c`: 5 info
  - added the optional property `ruleViolation` to the response with the `401` status
  - added the optional property `ruleViolation` to the response with the `403` status
  - added the optional property `ruleViolation` to the response with the `404` status
  - added the optional property `ruleViolation` to the response with the `409` status
  - …1 more
- **2025-12-16** `440db8997574`: 2 info
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
- **2024-09-06** `948bffd5d083`: 6 warning, 12 info
  - removed the optional property `error_code` from the response with the `404` status
  - removed the optional property `error_code` from the response with the `409` status
  - removed the optional property `error_code` from the response with the `500` status
  - removed the optional property `message` from the response with the `404` status
  - …14 more
- **2024-06-14** `18024dc32fcd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/apicurio/apis/apicurio-registry-api-v3/changes/groups/:groupId/artifacts/:artifactId/branches/post.md)

---

[API](https://skmtc.dev/apicurio/apis/apicurio-registry-api-v3.md) - [All operations](https://skmtc.dev/apicurio/apis/apicurio-registry-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/apicurio/apis/apicurio-registry-api-v3/revisions/ff9684af2aad?raw)