Skip to content
Try Gitea Cloud ☁️ for 30 days → Accelerate your Development & Deploys!
Gitea Documentation
Docs
API
Runner
Enterprise
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Version
1.28-dev
1.27.2
1.26.4
1.25.5
1.24.7
1.23.8
1.22.6
Sign In
Overview
admin
Overview
Lists all jobs
GET
Get all runners
GET
Get a global actions runner registration token
POST
Get a global runner
GET
Delete a global runner
DELETE
Update a global runner
PATCH
Lists all runs
GET
List cron tasks
GET
Run cron task
POST
List all emails
GET
Search all emails
GET
List system's webhooks
GET
Create a hook
POST
Get a hook
GET
Delete a hook
DELETE
Update a hook
PATCH
List all organizations
GET
List unadopted repositories
GET
Adopt unadopted files as a repository
POST
Delete unadopted files
DELETE
Search users according filter conditions
GET
Create a user
POST
Delete a user
DELETE
Edit an existing user
PATCH
List a user's badges
GET
Add a badge to a user
POST
Remove a badge from a user
DELETE
Add a public key on behalf of a user
POST
Delete a user's public key
DELETE
Create an organization
POST
Rename a user
POST
Create a repository on behalf of a user
POST
issue
Overview
Search for issues across the repositories that the user has access to
GET
List a repository's issues
GET
Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
POST
List all comments in a repository
GET
Get a comment
GET
Delete a comment
DELETE
Edit a comment
PATCH
List comment's attachments
GET
Create a comment attachment
POST
Get a comment attachment
GET
Delete a comment attachment
DELETE
Edit a comment attachment
PATCH
Get a list of reactions from a comment of an issue
GET
Add a reaction to a comment of an issue
POST
Remove a reaction from a comment of an issue
DELETE
Get an issue
GET
Delete an issue
DELETE
Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
PATCH
List issue's attachments
GET
Create an issue attachment
POST
Get an issue attachment
GET
Delete an issue attachment
DELETE
Edit an issue attachment
PATCH
Add assignees to an issue
POST
Remove assignees from an issue
DELETE
Check if a user can be assigned to an issue
GET
List issues that are blocked by this issue
GET
Block the issue given in the body by the issue in path
POST
Unblock the issue given in the body by the issue in path
DELETE
List all comments on an issue
GET
Add a comment to an issue
POST
Delete a comment
DELETE
Edit a comment
PATCH
Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
POST
List an issue's dependencies, i.e all issues that block this issue.
GET
Make the issue in the url depend on the issue in the form.
POST
Remove an issue dependency
DELETE
Get an issue's labels
GET
Replace an issue's labels
PUT
Add a label to an issue
POST
Remove all labels from an issue
DELETE
Remove a label from an issue
DELETE
Lock an issue
PUT
Unlock an issue
DELETE
Pin an Issue
POST
Unpin an Issue
DELETE
Moves the Pin to the given Position
PATCH
Get a list reactions of an issue
GET
Add a reaction to an issue
POST
Remove a reaction from an issue
DELETE
Delete an issue's existing stopwatch.
DELETE
Start stopwatch on an issue.
POST
Stop an issue's existing stopwatch.
POST
Get users who subscribed on an issue.
GET
Check if user is subscribed to an issue
GET
Subscribe user to issue
PUT
Unsubscribe user from issue
DELETE
List all comments and events on an issue
GET
List an issue's tracked times
GET
Add tracked time to a issue
POST
Reset a tracked time of an issue
DELETE
Delete specific tracked time
DELETE
Get all of a repository's labels
GET
Create a label
POST
Get a single label
GET
Delete a label
DELETE
Update a label
PATCH
Get all of a repository's opened milestones
GET
Create a milestone
POST
Get a milestone
GET
Delete a milestone
DELETE
Update a milestone
PATCH
miscellaneous
Overview
Returns a list of all gitignore templates
GET
Returns information about a gitignore template
GET
Returns a list of all label templates
GET
Returns all labels in a template
GET
Returns a list of all license templates
GET
Returns information about a license template
GET
Render a markdown document as HTML
POST
Render raw markdown as HTML
POST
Render a markup document as HTML
POST
Get default signing-key.gpg
GET
Get default signing-key.pub
GET
Get the currently authenticated token
GET
Delete the currently authenticated token
DELETE
Returns the version of the Gitea application
GET
notification
Overview
List users's notification threads
GET
Mark notification threads as read, pinned or unread
PUT
Check if unread notifications exist
GET
Get notification thread by ID
GET
Mark notification thread as read by ID
PATCH
List users's notification threads on a specific repo
GET
Mark notification threads as read, pinned or unread on a specific repo
PUT
organization
Overview
Create a repository in an organization
POST
Get list of organizations
GET
Create an organization
POST
Get an organization
GET
Delete an organization
DELETE
Edit an organization
PATCH
Get org-level workflow jobs
GET
Get org-level runners
GET
Get an organization's actions runner registration token
POST
Get an org-level runner
GET
Delete an org-level runner
DELETE
Update an org-level runner
PATCH
Get org-level workflow runs
GET
List an organization's actions secrets
GET
Create or Update a secret value in an organization
PUT
Delete a secret in an organization
DELETE
Get an org-level variables list
GET
Get an org-level variable
GET
Update an org-level variable
PUT
Create an org-level variable
POST
Delete an org-level variable
DELETE
List an organization's activity feeds
GET
Update Avatar
POST
Delete Avatar
DELETE
List users blocked by the organization
GET
Check if a user is blocked by the organization
GET
Block a user
PUT
Unblock a user
DELETE
List an organization's webhooks
GET
Create a hook
POST
Get a hook
GET
Delete a hook
DELETE
Update a hook
PATCH
List an organization's labels
GET
Create a label for an organization
POST
Get a single label
GET
Delete a label
DELETE
Update a label
PATCH
List an organization's members
GET
Check if a user is a member of an organization
GET
Remove a member from an organization
DELETE
List an organization's public members
GET
Check if a user is a public member of an organization
GET
Publicize a user's membership
PUT
Conceal a user's membership
DELETE
Rename an organization
POST
List an organization's repos
GET
Create a repository in an organization
POST
Delete all repositories in an organization
DELETE
List an organization's teams
GET
Create a team
POST
Search for teams within an organization
GET
Get a team
GET
Delete a team
DELETE
Edit a team
PATCH
List a team's activity feeds
GET
List a team's members
GET
List a particular member of team
GET
Add a team member
PUT
Remove a team member
DELETE
List a team's repos
GET
List a particular repo of team
GET
Add a repository to a team
PUT
Remove a repository from a team
DELETE
List the current user's organizations
GET
List a user's organizations
GET
Get user permissions in organization
GET
package
Overview
Gets all packages of an owner
GET
Gets all versions of a package
GET
Delete a package
DELETE
Gets the latest version of a package
GET
Link a package to a repository
POST
Unlink a package from a repository
POST
Gets a package
GET
Delete a package version
DELETE
Gets all files of a package
GET
repository
Overview
Migrate a remote git repository
POST
Search for repositories
GET
Get a repository
GET
Delete a repository
DELETE
Edit a repository's properties. Only fields that are set will be changed.
PATCH
Lists all artifacts for a repository
GET
Gets a specific artifact for a workflow run
GET
Deletes a specific artifact for a workflow run
DELETE
Downloads a specific artifact for a workflow run redirects to blob url
GET
Lists all jobs for a repository
GET
Gets a specific workflow job for a workflow run
GET
Downloads the job logs for a workflow run
GET
Get repo-level runners
GET
Get a repository's actions runner registration token
POST
Get a repo-level runner
GET
Delete a repo-level runner
DELETE
Update a repo-level runner
PATCH
Lists all runs for a repository run
GET
Gets a specific workflow run
GET
Delete a workflow run
DELETE
Lists all artifacts for a repository run
GET
Gets a specific workflow run attempt
GET
Lists all jobs for a workflow run attempt
GET
Lists all jobs for a workflow run
GET
Reruns a specific workflow job in a run
POST
Reruns an entire workflow run
POST
Reruns all failed jobs in a workflow run
POST
List an repo's actions secrets
GET
Create or Update a secret value in a repository
PUT
Delete a secret in a repository
DELETE
List a repository's action tasks
GET
Get repo-level variables list
GET
Get a repo-level variable
GET
Update a repo-level variable
PUT
Create a repo-level variable
POST
Delete a repo-level variable
DELETE
List repository workflows
GET
Get a workflow
GET
Disable a workflow
PUT
Create a workflow dispatch event
POST
Enable a workflow
PUT
List runs for a workflow
GET
List a repository's activity feeds
GET
Get an archive of a repository
GET
Return all users that have write access and can be assigned to issues
GET
Check if a user can be assigned to issues in a repository
GET
Update avatar
POST
Delete avatar
DELETE
List branch protections for a repository
GET
Create a branch protections for a repository
POST
Update the priorities of branch protections for a repository.
POST
Get a specific branch protection for the repository
GET
Delete a specific branch protection for the repository
DELETE
Edit a branch protections for a repository. Only fields that are set will be changed
PATCH
List a repository's branches
GET
Create a branch
POST
Retrieve a specific branch from a repository, including its effective branch protection
GET
Update a branch reference to a new commit
PUT
Delete a specific branch from a repository
DELETE
Rename a branch
PATCH
List a repository's collaborators
GET
Check if a user is a collaborator of a repository
GET
Add or Update a collaborator to a repository
PUT
Delete a collaborator from a repository
DELETE
Get repository permissions for a user
GET
Get a list of all commits from a repository
GET
Get a commit's combined status, by branch/tag/commit reference
GET
Get a commit's statuses, by branch/tag/commit reference
GET
Get the merged pull request of the commit
GET
Get commit comparison information
GET
Gets the metadata of all the entries of the root dir.
GET
Modify multiple files in a repository
POST
The extended "contents" API, to get file metadata and/or content, or list a directory.
GET
Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir.
GET
Update a file in a repository if SHA is set, or create the file if SHA is not set
PUT
Create a file in a repository
POST
Delete a file in a repository
DELETE
Apply diff patch to repository
POST
Get the EditorConfig definitions of a file in a repository
GET
Get the metadata and contents of requested files
GET
Get the metadata and contents of requested files
POST
List a repository's forks
GET
Fork a repository
POST
Gets the blob of a repository.
GET
Get a single commit from a repository
GET
Get a commit's diff or patch
GET
Get a note corresponding to a single commit from a repository
GET
Get specified ref or filtered repository's refs
GET
Get specified ref or filtered repository's refs
GET
Gets the tag object of an annotated tag (not lightweight tags)
GET
Gets the tree of a repository.
GET
List the hooks in a repository
GET
Create a hook
POST
List the Git hooks in a repository
GET
Get a Git hook
GET
Delete a Git hook in a repository
DELETE
Edit a Git hook in a repository
PATCH
Get a hook
GET
Delete a hook in a repository
DELETE
Edit a hook in a repository
PATCH
Test a push webhook
POST
Returns the issue config for a repo
GET
Returns the validation information for a issue config
GET
Get available issue templates for a repository
GET
List a repo's pinned issues
GET
List a repository's keys
GET
Add a key to a repository
POST
Get a repository's key by id
GET
Delete a key from a repository
DELETE
Get languages and number of bytes of code written
GET
Get repo licenses
GET
Get a file or it's LFS object from a repository
GET
Merge a branch from upstream
POST
Sync a mirrored repository
POST
Returns if new Issue Pins are allowed
GET
List a repo's pull requests
GET
Create a pull request
POST
Resolve a pull request review comment
POST
Unresolve a pull request review comment
POST
List a repo's pinned pull requests
GET
Get a pull request by base and head
GET
Get a pull request
GET
Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
PATCH
Get a pull request diff or patch
GET
Reply to a pull request review comment
POST
Get commits for a pull request
GET
Get changed files for a pull request
GET
Check if a pull request has been merged
GET
Merge a pull request
POST
Cancel the scheduled auto merge for the given pull request
DELETE
create review requests for a pull request
POST
cancel review requests for a pull request
DELETE
List all reviews for a pull request
GET
Create a review to a pull request
POST
Get a specific review for a pull request
GET
Submit a pending review to a pull request
POST
Delete a specific review from a pull request
DELETE
Get a specific review for a pull request
GET
Dismiss a review for a pull request
POST
Cancel to dismiss a review for a pull request
POST
Merge PR's baseBranch into headBranch
POST
Get all push mirrors of the repository
GET
add a push mirror to the repository
POST
Sync all push mirrored repository
POST
Get push mirror of the repository by remoteName
GET
deletes a push mirror from a repository by remoteName
DELETE
Get a file from a repository
GET
List a repo's releases
GET
Create a release
POST
Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at
GET
Get a release by tag name
GET
Delete a release by tag name
DELETE
Get a release
GET
Delete a release
DELETE
Update a release
PATCH
List release's attachments
GET
Create a release attachment
POST
Get a release attachment
GET
Delete a release attachment
DELETE
Edit a release attachment
PATCH
Return all users that can be requested to review in this repo
GET
Get signing-key.gpg for given repository
GET
Get signing-key.pub for given repository
GET
List a repo's stargazers
GET
Get a commit's statuses
GET
Create a commit status
POST
List a repo's watchers
GET
Check if the current user is watching a repo
GET
Watch a repo
PUT
Unwatch a repo
DELETE
List tag protections for a repository
GET
Create a tag protections for a repository
POST
Get a specific tag protection for the repository
GET
Delete a specific tag protection for the repository
DELETE
Edit a tag protections for a repository. Only fields that are set will be changed
PATCH
List a repository's tags
GET
Create a new git tag in a repository
POST
Get the tag of a repository by tag name
GET
Delete a repository's tag by name
DELETE
List a repository's teams
GET
Check if a team is assigned to a repository
GET
Add a team to a repository
PUT
Delete a team from a repository
DELETE
List a repo's tracked times
GET
List a user's tracked times in a repo
GET
Get list of topics that a repository has
GET
Replace list of topics for a repository
PUT
Add a topic to a repository
PUT
Delete a topic from a repository
DELETE
Transfer a repo ownership
POST
Accept a repo transfer
POST
Reject a repo transfer
POST
Create a wiki page
POST
Get a wiki page
GET
Delete a wiki page
DELETE
Edit a wiki page
PATCH
Get all wiki pages
GET
Get revisions of a wiki page
GET
Create a repository using a template
POST
Get a repository by id
GET
search topics via keyword
GET
Create a repository
POST
settings
Overview
Get instance's global settings for api
GET
Get instance's global settings for Attachment
GET
Get instance's global settings for repositories
GET
Get instance's global settings for ui
GET
user
Overview
Get the authenticated user
GET
Get workflow jobs
GET
Get user-level runners
GET
Get a user's actions runner registration token
POST
Get a user-level runner
GET
Delete a user-level runner
DELETE
Update a user-level runner
PATCH
Get workflow runs
GET
Create or Update a secret value in a user scope
PUT
Delete a secret in a user scope
DELETE
Get the user-level list of variables which is created by current doer
GET
Get a user-level variable which is created by current doer
GET
Update a user-level variable which is created by current doer
PUT
Create a user-level variable
POST
Delete a user-level variable which is created by current doer
DELETE
List the authenticated user's oauth2 applications
GET
creates a new OAuth2 application
POST
get an OAuth2 Application
GET
delete an OAuth2 Application
DELETE
update an OAuth2 Application, this includes regenerating the client secret
PATCH
Update Avatar
POST
Delete Avatar
DELETE
List users blocked by the authenticated user
GET
Check if a user is blocked by the authenticated user
GET
Block a user
PUT
Unblock a user
DELETE
List the authenticated user's email addresses
GET
Add email addresses
POST
Delete email addresses
DELETE
List the authenticated user's followers
GET
List the users that the authenticated user is following
GET
Check whether a user is followed by the authenticated user
GET
Follow a user
PUT
Unfollow a user
DELETE
Get a Token to verify
GET
Verify a GPG key
POST
List the authenticated user's GPG keys
GET
Create a GPG key
POST
Get a GPG key
GET
Remove a GPG key
DELETE
List the authenticated user's webhooks
GET
Create a hook
POST
Get a hook
GET
Delete a hook
DELETE
Update a hook
PATCH
List the authenticated user's public keys
GET
Create a public key
POST
Get a public key
GET
Delete a public key
DELETE
List the repos that the authenticated user owns
GET
Create a repository
POST
Get user settings
GET
Update user settings
PATCH
The repos that the authenticated user has starred
GET
Whether the authenticated is starring the repo
GET
Star the given repo
PUT
Unstar the given repo
DELETE
Get list of all existing stopwatches
GET
List repositories watched by the authenticated user
GET
List all the teams a user belongs to
GET
List the current user's tracked times
GET
Search for users
GET
Get a user
GET
List a user's activity feeds
GET
List the given user's followers
GET
List the users that the given user is following
GET
Check if one user is following another user
GET
List the given user's GPG keys
GET
Get a user's heatmap
GET
List the given user's public keys
GET
List the repos owned by the given user
GET
The repos that the given user has starred
GET
List the repositories watched by a user
GET
List the authenticated user's access tokens
GET
Create an access token
POST
delete an access token
DELETE
Select theme
Dark
Light
Auto
Version
1.28-dev
1.27.2
1.26.4
1.25.5
1.24.7
1.23.8
1.22.6
Sign In
Miscellaneous
miscellaneous
Section titled “miscellaneous”
Markdown rendering, signing keys, server version and instance metadata.
Operations
Section titled “Operations”
GET
/gitignore/templates
GET
/gitignore/templates/{name}
GET
/label/templates
GET
/label/templates/{name}
GET
/licenses
GET
/licenses/{name}
POST
/markdown
POST
/markdown/raw
POST
/markup
GET
/signing-key.gpg
GET
/signing-key.pub
GET
/token
DELETE
/token
GET
/version
