Delete a file in a repository

DELETE

/repos/{owner}/{repo}/contents/{filepath}

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

filepath

required

string

Path of the file to delete

Request Body

Media type application/json

DeleteFileOptions options for deleting files (used for other File structs below) Note: author and committer are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)

object

author

Identity for a person’s identity like an author or committer

object

email

string format: email

name

string

branch

Branch (optional) to base this file from. if not given, the default branch is used

string

committer

Identity for a person’s identity like an author or committer

object

email

string format: email

name

string

dates

CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE

object

author

string format: date-time

committer

string format: date-time

force_overwrite_new_branch

(optional) will do a force-push if the new branch already exists

boolean

message

Message (optional) for the commit of this file. if not supplied, a default message will be used

string

new_branch

New_branch (optional) will make a new branch from branch before creating the file

string

sha

required

Sha is the SHA for the file that already exists

string

signoff

Add a Signed-off-by trailer by the committer at the end of the commit log message.

boolean

Example ^generated

{
  "author": {
    "email": "hello@example.com",
    "name": "example"
  },
  "branch": "example",
  "committer": {
    "email": "hello@example.com",
    "name": "example"
  },
  "dates": {
    "author": "2026-04-15T12:00:00Z",
    "committer": "2026-04-15T12:00:00Z"
  },
  "force_overwrite_new_branch": true,
  "message": "example",
  "new_branch": "example",
  "sha": "example",
  "signoff": true
}

Responses

200

FileDeleteResponse

Media type application/json

FileDeleteResponse contains information about a repo’s file that was deleted

object

commit

FileCommitResponse contains information generated from a Git commit for a repo's file.

object

author

CommitUser contains information of a user in the context of a commit.

object

date

string

email

string format: email

name

string

committer

CommitUser contains information of a user in the context of a commit.

object

date

string

email

string format: email

name

string

created

string format: date-time

html_url

string

message

string

parents

Array<object>

CommitMeta contains meta information of a commit in terms of API.

object

created

string format: date-time

sha

string

url

string

sha

string

tree

CommitMeta contains meta information of a commit in terms of API.

object

created

string format: date-time

sha

string

url

string

url

string

content

verification

PayloadCommitVerification represents the GPG verification of a commit

object

payload

string

reason

string

signature

string

signer

PayloadUser represents the author or committer of a commit

object

email

string format: email

name

Full name of the commit author

string

username

string

verified

boolean

Example ^generated

{
  "commit": {
    "author": {
      "date": "example",
      "email": "hello@example.com",
      "name": "example"
    },
    "committer": {
      "date": "example",
      "email": "hello@example.com",
      "name": "example"
    },
    "created": "2026-04-15T12:00:00Z",
    "html_url": "example",
    "message": "example",
    "parents": [
      {
        "created": "2026-04-15T12:00:00Z",
        "sha": "example",
        "url": "example"
      }
    ],
    "sha": "example",
    "tree": {
      "created": "2026-04-15T12:00:00Z",
      "sha": "example",
      "url": "example"
    },
    "url": "example"
  },
  "content": "example",
  "verification": {
    "payload": "example",
    "reason": "example",
    "signature": "example",
    "signer": {
      "email": "hello@example.com",
      "name": "example",
      "username": "example"
    },
    "verified": true
  }
}

400

APIError is error format response

Media type application/json

APIError is an api error with a message

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}

403

APIError is error format response

Media type application/json

APIError is an api error with a message

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}

404

APIError is error format response

Media type application/json

APIError is an api error with a message

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}

413

QuotaExceeded

Media type application/json

Headers

message

string

user_id

integer format: int64

username

string

423

APIRepoArchivedError is an error that is raised when an archived repo should be modified

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}