Search documentation
karat

+

K

User Documentation ↗

Create Branch

POST/api/v2/datasets/{datasetRid}/branches
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

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 a Dataset.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Request body

CreateBranchRequest
object
Hide children

Hide children

transactionRid
string
optional

The Resource Identifier (RID) of a Transaction.

name
string

The name of a Branch.

Response body

Branch
object

The created Branch

Hide children

Hide children

name
string

The name of a Branch.

transactionRid
string
optional

The Resource Identifier (RID) of a Transaction.

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches?preview=true" \ -d '{"transactionRid":"ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4","name":"master"}'

Response

Copied!
1 2 3 4 { "transactionRid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4", "name": "master" }