Gitea

https://docs.gitea.com
Admin
Gitea is a self-hosted, all-in-one software development service that provides Git hosting, code...
Tokens:1,276,604
Snippets:7,290
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install package example

Source: https://docs.gitea.com/usage/packages/npm

Example of installing a scoped package from the registry.

```bash
npm install @test/test_package

```

--------------------------------

### Install testpackage example

Source: https://docs.gitea.com/usage/packages/cran

Example command to install the 'testpackage' package from the registry.

```r
install.packages("testpackage")
```

--------------------------------

### Example: Install ConanPackage/1.2@gitea/final

Source: https://docs.gitea.com/usage/packages/conan

Example command to install a specific recipe from the 'gitea' remote.

```bash
conan install --remote=gitea ConanPackage/1.2@gitea/final
```

--------------------------------

### Example gem install command

Source: https://docs.gitea.com/usage/packages/rubygems

Example command to install a package from the RubyGems registry.

```bash
gem install --host https://gitea.example.com/api/packages/testuser/rubygems test_package

```

--------------------------------

### Example pip install command

Source: https://docs.gitea.com/usage/packages/pypi

Example pip install command with concrete values for the placeholders shown in the previous snippet.

```bash
pip install --index-url https://testuser:password123@gitea.example.com/api/packages/testuser/pypi/simple --no-deps test_package

```

--------------------------------

### Example vagrant box add command

Source: https://docs.gitea.com/usage/packages/vagrant

Example command to install a box named test_system from the testuser owner. This installs the latest version.

```bash
vagrant box add "https://gitea.example.com/api/packages/testuser/vagrant/test_system"
```

--------------------------------

### Install package examples with dart pub add

Source: https://docs.gitea.com/usage/packages/pub

Example commands for installing the latest version or a specific version of a package. The first command uses the latest version, the second specifies version 1.0.8.

```bash
# use latest version
dart pub add mypackage --hosted-url=https://gitea.example.com/api/packages/testuser/pub/
# specify version
dart pub add mypackage:1.0.8 --hosted-url=https://gitea.example.com/api/packages/testuser/pub/
```

--------------------------------

### Fetch and cURL examples for GET /users/{username}/following

Source: https://docs.gitea.com/api/operations/user-list-following

Two equivalent client examples for the GET /users/{username}/following endpoint. The JavaScript example uses fetch with Basic authentication and logs the response or error. The cURL example sends the same GET request with a Basic Authorization header.

```javascript
const url = 'https://gitea.com/api/v1/users/example/following';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```bash
curl --request GET \
  --url https://gitea.com/api/v1/users/example/following \
  --header 'Authorization: Basic <credentials>'
```

--------------------------------

### Fetch and cURL examples for GET /repos/{owner}/{repo}/new_pin_allowed

Source: https://docs.gitea.com/api/operations/repo-new-pin-allowed

Two equivalent client examples for the GET /repos/{owner}/{repo}/new_pin_allowed endpoint. The JavaScript snippet uses fetch with Basic authentication and logs the JSON response or error. The cURL command sends the same GET request with the same Authorization header.

```javascript
const url = 'https://gitea.com/api/v1/repos/example/example/new_pin_allowed';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```bash
curl --request GET \
  --url https://gitea.com/api/v1/repos/example/example/new_pin_allowed \
  --header 'Authorization: Basic <credentials>'
```

--------------------------------

### Fetch and curl examples for GET /user/keys

Source: https://docs.gitea.com/enterprise/api/operations/user-current-list-keys

Two client examples for the GET /user/keys endpoint. The JavaScript snippet uses fetch with Basic authentication and logs the JSON response; the curl command sends the same request with an Authorization header. Both require valid credentials.

```javascript
const url = 'https://gitea.example.com/api/v1/user/keys';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```bash
curl --request GET \
  --url https://gitea.example.com/api/v1/user/keys \
  --header 'Authorization: Basic <credentials>'
```

--------------------------------

### Example response for global repository settings

Source: https://docs.gitea.com/api/operations/get-general-repository-settings

Example JSON response from the GET /settings/repository endpoint, showing all boolean fields set to true.

```json
{
  "http_git_disabled": true,
  "lfs_disabled": true,
  "migrations_disabled": true,
  "mirrors_disabled": true,
  "stars_disabled": true,
  "time_tracking_disabled": true
}
```

--------------------------------

### Example: Publish ConanPackage/1.2@gitea/final

Source: https://docs.gitea.com/usage/packages/conan

Example command to upload a specific recipe to the 'gitea' remote.

```bash
conan upload --remote=gitea ConanPackage/1.2@gitea/final
```

--------------------------------

### Fetch example for POST /repos/{owner}/{repo}/push_mirrors

Source: https://docs.gitea.com/api/operations/repo-add-push-mirror

JavaScript example using fetch to create a push mirror. Requires Basic authentication and a JSON body with the push mirror options.

```javascript
const url = 'https://gitea.com/api/v1/repos/example/example/push_mirrors';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"interval":"example","remote_address":"example","remote_password":"example","remote_username":"example","sync_on_commit":true}'
};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

--------------------------------

### Fetch and curl examples for GET /user/starred

Source: https://docs.gitea.com/api/operations/user-current-list-starred

Two client examples for the GET /user/starred endpoint. The JavaScript example uses fetch with Basic authentication and logs the JSON response or error. The curl example sends the same request with the Authorization header.

```javascript
const url = 'https://gitea.com/api/v1/user/starred';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```bash
curl --request GET \
  --url https://gitea.com/api/v1/user/starred \
  --header 'Authorization: Basic <credentials>'
```

--------------------------------

### Example 200 response for GET /orgs/{org}/actions/jobs

Source: https://docs.gitea.com/api/operations/get-org-workflow-jobs

Example 200 response body for the Get org-level workflow jobs endpoint. Shows the structure of ActionWorkflowJobsResponse with jobs array and total_count.

```json
{
  "jobs": [
    {
      "completed_at": "2026-04-15T12:00:00Z",
      "conclusion": "example",
      "created_at": "2026-04-15T12:00:00Z",
      "head_branch": "example",
      "head_sha": "example",
      "html_url": "https://example.com",
      "id": 1,
      "labels": [
        "example"
      ],
      "name": "example",
      "run_attempt": 1,
      "run_id": 1,
      "run_url": "https://example.com",
      "runner_id": 1,
      "runner_name": "example",
      "started_at": "2026-04-15T12:00:00Z",
      "status": "example",
      "steps": [
        {
          "completed_at": "2026-04-15T12:00:00Z",
          "conclusion": "example",
          "name": "example",
          "number": 1,
          "started_at": "2026-04-15T12:00:00Z",
          "status": "example"
        }
      ],
      "url": "https://example.com"
    }
  ],
  "total_count": 1
}
```

--------------------------------

### Start Gitea web server

Source: https://docs.gitea.com/administration/command-line

Starts the Gitea web server. The first example uses default settings, the second overrides the port, and the third specifies a custom configuration file and pid file.

```bash
gitea web
```

```bash
gitea web --port 80
```

```bash
gitea web --config /etc/gitea.ini --pid /some/custom/gitea.pid
```

--------------------------------

### GET /admin/actions/runners

Source: https://docs.gitea.com/enterprise/api/operations/get-admin-runners

Documentation for the GET /admin/actions/runners endpoint, including parameters, response schema, and examples.

```APIDOC
## GET /admin/actions/runners

### Description
Retrieves a list of all runners registered in the Gitea instance. This endpoint is for administrative purposes and requires appropriate authentication.

### Method
GET

### Endpoint
/admin/actions/runners

### Parameters
#### Query Parameters
- **disabled** (boolean) - Optional - Filter by disabled status (true or false)

### Request Example
No request body is required.

### Response
#### Success Response (200)
Returns an `ActionRunnersResponse` object containing a list of runners.

- **runners** (Array<object>) - List of `ActionRunner` objects.
  - **busy** (boolean) - Indicates if the runner is busy.
  - **disabled** (boolean) - Indicates if the runner is disabled.
  - **ephemeral** (boolean) - Indicates if the runner is ephemeral.
  - **id** (integer, int64) - Runner ID.
  - **labels** (Array<object>) - List of `ActionRunnerLabel` objects.
    - **id** (integer, int64) - Label ID.
    - **name** (string) - Label name.
    - **type** (string) - Label type.
  - **name** (string) - Runner name.
  - **status** (string) - Runner status.
- **total_count** (integer, int64) - Total number of runners.

#### Response Example
```json
{
  "runners": [
    {
      "busy": true,
      "disabled": true,
      "ephemeral": true,
      "id": 1,
      "labels": [
        {
          "id": 1,
          "name": "example",
          "type": "example"
        }
      ],
      "name": "example",
      "status": "example"
    }
  ],
  "total_count": 1
}
```

### Error Responses
#### 400 Bad Request
Returns an `APIError` object with fields:
- **message** (string) - Error message.
- **url** (string) - URL related to the error.

#### 404 Not Found
Returns an `APINotFound` empty response.
```

--------------------------------

### Install a Go package with GOPROXY

Source: https://docs.gitea.com/usage/packages/go

Installs a Go package by setting the GOPROXY environment variable to the package registry. Use @latest for the latest version or @{package_version} for a specific version. Credentials are required if the owner is private.

```bash
# use latest version
GOPROXY=https://gitea.example.com/api/packages/{owner}/go go install {package_name}
# or
GOPROXY=https://gitea.example.com/api/packages/{owner}/go go install {package_name}@latest
# use specific version
GOPROXY=https://gitea.example.com/api/packages/{owner}/go go install {package_name}@{package_version}
```

--------------------------------

### Pre-Fill New File Example Request

Source: https://docs.gitea.com/development/integrations

Example request that opens a new file named hello-world.md with the content "Hello, World!" in the articles directory of the johndoe/bliss repository.

```http
GET https://git.example.com/johndoe/bliss/_new/articles/
    ?filename=hello-world.md
    &value=Hello%2C%20World!

```

--------------------------------

### Search issues with GET /repos/issues/search

Source: https://docs.gitea.com/api/operations/issue-search-issues

Example requests for the GET /repos/issues/search endpoint. Both use Basic authentication with placeholder credentials and query parameters for state, type, and various filters. The JavaScript example uses fetch and logs the response or error; the curl example sends the request directly.

```javascript
const url = 'https://gitea.com/api/v1/repos/issues/search?state=open&type=issues&assigned=false&created=false&mentioned=false&review_requested=false&reviewed=false&page=1';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```curl
curl --request GET \
  --url 'https://gitea.com/api/v1/repos/issues/search?state=open&type=issues&assigned=false&created=false&mentioned=false&review_requested=false&reviewed=false&page=1' \
  --header 'Authorization: Basic <credentials>'
```

--------------------------------

### Fetch and curl examples for getting a single commit

Source: https://docs.gitea.com/enterprise/api/operations/repo-get-single-commit

Two equivalent examples for fetching a single commit from the Gitea API: a JavaScript fetch call and a curl command. Both use the GET endpoint /repos/{owner}/{repo}/git/commits/{sha} with Basic authentication. The fetch example parses the JSON response and logs it, while the curl example outputs the raw response.

```javascript
const url = 'https://gitea.example.com/api/v1/repos/example/example/git/commits/example';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

```

```bash
curl --request GET \
  --url https://gitea.example.com/api/v1/repos/example/example/git/commits/example \
  --header 'Authorization: Basic <credentials>'

```

--------------------------------

### Start the cache server

Source: https://docs.gitea.com/runner/cache

Start the dedicated cache server using the configuration file.

```bash
gitea-runner -c cache-server-config.yaml cache-server

```

--------------------------------

### Install Debian package with apt

Source: https://docs.gitea.com/usage/packages/debian

Commands to install a package from the Debian registry. Use the first to get the latest version, the second to install a specific version.

```bash
# use latest version
apt install {package_name}
# use specific version
apt install {package_name}={package_version}
```

--------------------------------

### Install a package

Source: https://docs.gitea.com/usage/packages/npm

Installs a package from the configured registry.

```bash
npm install {package_name}

```

--------------------------------

### Run Gitea web server

Source: https://docs.gitea.com/installation/install-from-source

Starts the Gitea web server from the built binary. The binary must be built first as described in the installation process; the command runs it from the current directory.

```bash
./gitea web
```

--------------------------------

### Check team assignment with fetch and curl

Source: https://docs.gitea.com/enterprise/api/operations/repo-check-team

Two equivalent client examples for the GET /repos/{owner}/{repo}/teams/{team} endpoint. The JavaScript example uses fetch with Basic authentication and logs the JSON response or error. The curl example sends the same GET request with a Basic Authorization header.

```javascript
const url = 'https://gitea.example.com/api/v1/repos/example/example/teams/example';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```bash
curl --request GET \
  --url https://gitea.example.com/api/v1/repos/example/example/teams/example \
  --header 'Authorization: Basic <credentials>'
```

--------------------------------

### Create project with fetch

Source: https://docs.gitea.com/api/operations/user-current-create-project

Use this fetch example to create a project owned by the authenticated user. It sends a POST request to /user/projects with Basic authentication and a JSON body containing card_type, description, template_type, and title.

```javascript
const url = 'https://gitea.com/api/v1/user/projects';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"card_type":"example","description":"example","template_type":"example","title":"example"}'
};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

--------------------------------

### Install supervisor with apt

Source: https://docs.gitea.com/installation/linux-service

Installs supervisor on Debian/Ubuntu systems using apt.

```bash
sudo apt install supervisor

```

--------------------------------

### GET /orgs/{org}/branch_protection_inheritance

Source: https://docs.gitea.com/enterprise/api/operations/org-get-branch-protection-inheritance

Documentation for the GET /orgs/{org}/branch_protection_inheritance endpoint, including parameters, responses, and examples.

```APIDOC
## [GET] /orgs/{org}/branch_protection_inheritance

### Description
Gets the force branch protection inheritance setting of an organization. This endpoint is Gitea Enterprise only and is not part of the community edition.

### Method
GET

### Endpoint
/orgs/{org}/branch_protection_inheritance

### Parameters
#### Path Parameters
- **org** (string) - Required - Name of the organization

### Request Example
```
const url = 'https://gitea.example.com/api/v1/orgs/example/branch_protection_inheritance';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request GET \
  --url https://gitea.example.com/api/v1/orgs/example/branch_protection_inheritance \
  --header 'Authorization: Basic <credentials>'
```

### Response
#### Success Response (200)
- **force_inheritance** (boolean) - Whether all repositories of the organization are forced to inherit the organization’s branch protection rules. When enabled, a repository can not opt out of inheritance.

#### Response Example
```
{
  "force_inheritance": true
}
```

#### Error Response (404)
APINotFound is a not found empty response.
```

--------------------------------

### GET /user/actions/variables

Source: https://docs.gitea.com/api/operations/get-user-variables-list

This snippet documents the GET /user/actions/variables endpoint, including its query parameters, request examples, and response schema.

```APIDOC
## GET /user/actions/variables

### Description
Retrieves the list of variables created by the current authenticated user at the user level.

### Method
GET

### Endpoint
/user/actions/variables

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number of results to return (1-based)
- **limit** (integer) - Optional - Page size of results

### Request Example
```
const url = 'https://gitea.com/api/v1/user/actions/variables';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request GET \
  --url https://gitea.com/api/v1/user/actions/variables \
  --header 'Authorization: Basic <credentials>'
```

### Response
#### Success Response (200)
Returns an array of _ActionVariable_ objects. Each object contains:
- **data** (string) - The value of the variable
- **description** (string) - The description of the variable
- **name** (string) - The name of the variable
- **owner_id** (integer, int64) - The owner to which the variable belongs
- **repo_id** (integer, int64) - The repository to which the variable belongs

#### Response Example
```json
[
  {
    "data": "example",
    "description": "example",
    "name": "example",
    "owner_id": 1,
    "repo_id": 1
  }
]
```

### Error Responses
- **400** - APIError is error format response. Headers: message (string), url (string)
- **404** - APINotFound is a not found empty response
```

--------------------------------

### Enable and start supervisor with systemd

Source: https://docs.gitea.com/installation/linux-service

Enables and starts supervisor at boot. Run after appending the supervisord config and editing user/home settings.

```bash
sudo systemctl enable supervisor
sudo systemctl start supervisor

```

--------------------------------

### Example 200 response for GET /admin/actions/runners/{runner_id}

Source: https://docs.gitea.com/api/operations/get-admin-runner

Example response body for a successful 200 request, representing an ActionRunner object.

```json
{
  "busy": true,
  "disabled": true,
  "ephemeral": true,
  "id": 1,
  "labels": [
    {
      "id": 1,
      "name": "example",
      "type": "example"
    }
  ],
  "name": "example",
  "status": "example"
}
```

--------------------------------

### cURL example for GET /user/emails

Source: https://docs.gitea.com/enterprise/api/operations/user-list-emails

Uses curl to send a GET request to the Gitea API endpoint /user/emails with Basic authentication.

```cURL
curl --request GET \
  --url https://gitea.example.com/api/v1/user/emails \
  --header 'Authorization: Basic <credentials>'
```

--------------------------------

### Enable and start Gitea with systemd

Source: https://docs.gitea.com/installation/linux-service

Enables and starts the Gitea systemd service at boot. Run after copying and editing the gitea.service file.

```bash
sudo systemctl enable gitea
sudo systemctl start gitea

```

--------------------------------

### cURL example for GET /admin/audit-logs/export

Source: https://docs.gitea.com/enterprise/api/operations/admin-export-audit-logs

Uses curl to send a GET request to the export endpoint with Basic authentication. The response is not shown.

```bash
curl --request GET \
  --url https://gitea.example.com/api/v1/admin/audit-logs/export \
  --header 'Authorization: Basic <credentials>'
```

--------------------------------

### Create project with fetch

Source: https://docs.gitea.com/api/operations/repo-create-project

JavaScript example using fetch to create a project owned by a repository. Requires Basic authentication credentials and a JSON body with card_type, description, template_type, and title. The response is logged to the console.

```javascript
const url = 'https://gitea.com/api/v1/repos/example/example/projects';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"card_type":"example","description":"example","template_type":"example","title":"example"}'
};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

--------------------------------

### Get a workflow with fetch

Source: https://docs.gitea.com/api/operations/actions-get-workflow

JavaScript example using fetch to call the Get a workflow endpoint. Requires Basic authentication credentials.

```javascript
const url = 'https://gitea.com/api/v1/repos/example/example/actions/workflows/example';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```
Tokens:
Raw