Open documentation ↗Overview
This documentation describes the Gitea API.
Gitea API. is a development API from gitea.io. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 325 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Development
- Version
- 1.20.0+dev-93-g6886706f5
- Endpoints
- 325
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /activitypub/user/{username} | Returns the Person actor for a user |
| POST | /activitypub/user/{username}/inbox | Send to the inbox |
| GET | /admin/cron | List cron tasks |
| POST | /admin/cron/{task} | Run cron task |
| GET | /admin/hooks | List system's webhooks |
| POST | /admin/hooks | Create a hook |
| GET | /admin/hooks/{id} | Get a hook |
| PATCH | /admin/hooks/{id} | Update a hook |
| GET | /admin/orgs | List all organizations |
| GET | /admin/unadopted | List unadopted repositories |
| POST | /admin/unadopted/{owner}/{repo} | Adopt unadopted files as a repository |
| DELETE | /admin/unadopted/{owner}/{repo} | Delete unadopted files |
| GET | /admin/users | List all users |
| POST | /admin/users | Create a user |
| PATCH | /admin/users/{username} | Edit an existing user |
| DELETE | /admin/users/{username} | Delete a user |
| POST | /admin/users/{username}/keys | Add a public key on behalf of a user |
| DELETE | /admin/users/{username}/keys/{id} | Delete a user's public key |
| POST | /admin/users/{username}/orgs | Create an organization |
| POST | /admin/users/{username}/repos | Create a repository on behalf of a user |
| DELETE | /amdin/hooks/{id} | Delete a hook |
| POST | /markdown | Render a markdown document as HTML |
| POST | /markdown/raw | Render raw markdown as HTML |
| GET | /nodeinfo | Returns the nodeinfo of the Gitea application |
| GET | /notifications | List users's notification threads |
| PUT | /notifications | Mark notification threads as read, pinned or unread |
| GET | /notifications/new | Check if unread notifications exist |
| GET | /notifications/threads/{id} | Get notification thread by ID |
| PATCH | /notifications/threads/{id} | Mark notification thread as read by ID |
| POST | /org/{org}/reposdeprecated | Create a repository in an organization |
| GET | /orgs | Get list of organizations |
| POST | /orgs | Create an organization |
| GET | /orgs/{org} | Get an organization |
| PATCH | /orgs/{org} | Edit an organization |
| DELETE | /orgs/{org} | Delete an organization |
| GET | /orgs/{org}/hooks | List an organization's webhooks |
| POST | /orgs/{org}/hooks | Create a hook |
| GET | /orgs/{org}/hooks/{id} | Get a hook |
| PATCH | /orgs/{org}/hooks/{id} | Update a hook |
| DELETE | /orgs/{org}/hooks/{id} | Delete a hook |
| GET | /orgs/{org}/labels | List an organization's labels |
| POST | /orgs/{org}/labels | Create a label for an organization |
| GET | /orgs/{org}/labels/{id} | Get a single label |
| PATCH | /orgs/{org}/labels/{id} | Update a label |
| DELETE | /orgs/{org}/labels/{id} | Delete a label |
| GET | /orgs/{org}/members | List an organization's members |
| GET | /orgs/{org}/members/{username} | Check if a user is a member of an organization |
| DELETE | /orgs/{org}/members/{username} | Remove a member from an organization |
| GET | /orgs/{org}/public_members | List an organization's public members |
| GET | /orgs/{org}/public_members/{username} | Check if a user is a public member of an organization |
| PUT | /orgs/{org}/public_members/{username} | Publicize a user's membership |
| DELETE | /orgs/{org}/public_members/{username} | Conceal a user's membership |
| GET | /orgs/{org}/repos | List an organization's repos |
| POST | /orgs/{org}/repos | Create a repository in an organization |
| GET | /orgs/{org}/teams | List an organization's teams |
| POST | /orgs/{org}/teams | Create a team |
| GET | /orgs/{org}/teams/search | Search for teams within an organization |
| GET | /packages/{owner} | Gets all packages of an owner |
| GET | /packages/{owner}/{type}/{name}/{version} | Gets a package |
| DELETE | /packages/{owner}/{type}/{name}/{version} | Delete a package |
| GET | /packages/{owner}/{type}/{name}/{version}/files | Gets all files of a package |
| GET | /repos/issues/search | Search for issues across the repositories that the user has access to |
| POST | /repos/migrate | Migrate a remote git repository |
| GET | /repos/search | Search for repositories |
| GET | /repos/{owner}/{repo} | Get a repository |
| PATCH | /repos/{owner}/{repo} | Edit a repository's properties. Only fields that are set will be changed. |
| DELETE | /repos/{owner}/{repo} | Delete a repository |
| GET | /repos/{owner}/{repo}/archive/{archive} | Get an archive of a repository |
| GET | /repos/{owner}/{repo}/assignees | Return all users that have write access and can be assigned to issues |
| GET | /repos/{owner}/{repo}/branch_protections | List branch protections for a repository |
| POST | /repos/{owner}/{repo}/branch_protections | Create a branch protections for a repository |
| GET | /repos/{owner}/{repo}/branch_protections/{name} | Get a specific branch protection for the repository |
| PATCH | /repos/{owner}/{repo}/branch_protections/{name} | Edit a branch protections for a repository. Only fields that are set will be changed |
| DELETE | /repos/{owner}/{repo}/branch_protections/{name} | Delete a specific branch protection for the repository |
| GET | /repos/{owner}/{repo}/branches | List a repository's branches |
| POST | /repos/{owner}/{repo}/branches | Create a branch |
| GET | /repos/{owner}/{repo}/branches/{branch} | Retrieve a specific branch from a repository, including its effective branch protection |
| DELETE | /repos/{owner}/{repo}/branches/{branch} | Delete a specific branch from a repository |
| GET | /repos/{owner}/{repo}/collaborators | List a repository's collaborators |
| GET | /repos/{owner}/{repo}/collaborators/{collaborator} | Check if a user is a collaborator of a repository |
| PUT | /repos/{owner}/{repo}/collaborators/{collaborator} | Add a collaborator to a repository |
| DELETE | /repos/{owner}/{repo}/collaborators/{collaborator} | Delete a collaborator from a repository |
| GET | /repos/{owner}/{repo}/collaborators/{collaborator}/permission | Get repository permissions for a user |
| GET | /repos/{owner}/{repo}/commits | Get a list of all commits from a repository |
| GET | /repos/{owner}/{repo}/commits/{ref}/status | Get a commit's combined status, by branch/tag/commit reference |
| GET | /repos/{owner}/{repo}/commits/{ref}/statuses | Get a commit's statuses, by branch/tag/commit reference |
| GET | /repos/{owner}/{repo}/contents | Gets the metadata of all the entries of the root dir |
| GET | /repos/{owner}/{repo}/contents/{filepath} | Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir |
| POST | /repos/{owner}/{repo}/contents/{filepath} | Create a file in a repository |
| PUT | /repos/{owner}/{repo}/contents/{filepath} | Update a file in a repository |
| DELETE | /repos/{owner}/{repo}/contents/{filepath} | Delete a file in a repository |
| POST | /repos/{owner}/{repo}/diffpatch | Apply diff patch to repository |
| GET | /repos/{owner}/{repo}/editorconfig/{filepath} | Get the EditorConfig definitions of a file in a repository |
| GET | /repos/{owner}/{repo}/forks | List a repository's forks |
| POST | /repos/{owner}/{repo}/forks | Fork a repository |
| GET | /repos/{owner}/{repo}/git/blobs/{sha} | Gets the blob of a repository. |
| GET | /repos/{owner}/{repo}/git/commits/{sha} | Get a single commit from a repository |
| GET | /repos/{owner}/{repo}/git/commits/{sha}.{diffType} | Get a commit's diff or patch |
| GET | /repos/{owner}/{repo}/git/notes/{sha} | Get a note corresponding to a single commit from a repository |
| GET | /repos/{owner}/{repo}/git/refs | Get specified ref or filtered repository's refs |
Showing the first 100 of 325 endpoints; the full list is in the documentation.
Questions
Does the Gitea API. API need an API key?
Yes. The Gitea API. API uses API key authentication; the documentation explains how to get credentials.
Does the Gitea API. API support HTTPS?
Yes, the Gitea API. API is served over HTTPS.
How many endpoints does the Gitea API. API have?
Its OpenAPI description lists 325 endpoints in version 1.20.0+dev-93-g6886706f5. The first 100 are shown on this page.
What are alternatives to the Gitea API. API?
Other Development APIs include Cloudflare, Azure DevOps, IPify, App Store Connect API, StackExchange.
Similar development APIs
Compare alternatives →Cloudflare
DevelopmentManage DNS, CDN, Workers and other services; documented with an official OpenAPI 3.0 spec
API key
Azure DevOps
DevelopmentThe Azure DevOps basic components of a REST API request/response pair
API key
IPify
DevelopmentA simple IP Address API
No auth
App Store Connect API
DevelopmentThe data structure that represents an app store connect api resource.
Bearer token252 endpoints
StackExchange
DevelopmentQ&A forum for developers
OAuth124 endpoints
IPinfo
DevelopmentAnother simple IP Address API
No auth
Listed from APIs.guru (CC0).