Search documentation
karat

+

K

User Documentation ↗

Create Branch

POST/api/v1/datasets/{datasetRid}/branches

Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-write.

Path parameters

datasetRid
string

The Resource Identifier (RID) of the Dataset on which to create the Branch.

Request body

CreateBranchRequest
object
Hide children

Hide children

branchId
string

The identifier (name) of a Branch. Example: master.

transactionRid
string
optional

The Resource Identifier (RID) of a Transaction. Example: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4.

Response body

Branch
object

A Branch of a Dataset.

Hide children

Hide children

branchId
string

The identifier (name) of a Branch. Example: master.

transactionRid
string
optional

The Resource Identifier (RID) of a Transaction. Example: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4.

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches" \ -d '{"branchId":"my-branch"}'

Response

Copied!
1 2 3 { "branchId": "my-branch" }