Delete a branch¶

DELETE /api/v5/repos/{owner}/{repo}/branches/{name}

Deletes the specified branch in the specified repository. On success the target branch is removed and the response body is empty.

Supported access tokens¶

• AtomGit user access tokens

Anonymous access allowed¶

This endpoint does not allow anonymous access.

Request parameters¶

Response parameters¶

On success this endpoint has no response body (HTTP 204/200, returning ResponseEntity<Void>) and returns no business data.

Error response¶

401 Unauthenticated

{
  "error": "unauthorized",
  "message": "Missing or invalid access token"
}

404 Resource does not exist

{
  "error": "not_found",
  "message": "Branch does not exist"
}

Error field names follow what the backend actually returns; the examples here are illustrative only.

HTTP status codes¶

Request example¶

Parameter notes¶

Replace <owner> with the namespace address to which the repository belongs (the address path of the enterprise, organization, or user); replace <repo> with the repository path (path); replace <name> with the name of the branch to delete; replace <token> with your AtomGit user access token.

cURL¶

curl -X DELETE 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/branches/<name>?access_token=<token>' \
  -H 'Accept: application/json'

JavaScript¶

// Native fetch (Node.js 18+ / browsers)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/branches/<name>?access_token=<token>",
  {
    method: "DELETE",
    headers: {
      "Accept": "application/json",
    },
  }
);

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.text();
console.log(data);

Python¶

import requests

resp = requests.delete(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/branches/<name>?access_token=<token>",
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.text)

Response example¶

Status code: 204

On successful deletion the response body is empty (204 No Content) and no content is returned.

Error codes¶