API Reference

Delete Branch

DELETE/api/v2/datasets/{datasetRid}/branches/{branchName}

Deletes the Branch with the given BranchName.

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.

branchName

string

The name of a Branch.

Examples

Request

Copied!

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

Error responses

Error Name
`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, branchName`
`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`
`DeleteBranchPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not delete the Branch.
	Parameters	`datasetRid, branchName`

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