Delete Branch

DELETE/api/v1/datasets/{datasetRid}/branches/{branchId}

Deletes the Branch with the given BranchId.

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 that contains the Branch.

branchId

string

The identifier (name) of the Branch.

Examples

Request

Copied!

curl -X DELETE \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches/my-branch"

Error responses

Error Name
`DeleteBranchPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	The provided token does not have permission to delete the given branch from this dataset.
	Parameters	`datasetRid, branchId`
`InvalidBranchId`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs.
	Parameters	`branchId`
`BranchNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The requested branch could not be found, or the client token does not have access to it.
	Parameters	`datasetRid, branchId`
`DatasetNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The requested dataset could not be found, or the client token does not have access to it.
	Parameters	`datasetRid`

See Errors for a general overview of errors in the platform.