Forgejo

Forgejo settings API

The settings API from Forgejo — 4 operation(s) for settings.

GitHub OpenAPI

Operations 4

GET /settings/api Get instance's global settings for api #
GET /settings/attachment Get instance's global settings for Attachment #
GET /settings/repository Get instance's global settings for repositories #
GET /settings/ui Get instance's global settings for ui #

Documentation

📖
Documentation
https://forgejo.org/docs/latest/user/api-usage/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/forgejo/refs/heads/main/openapi/forgejo-settings-api-openapi.yml

Other Resources

🔗
Swagger
https://code.forgejo.org/api/swagger

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/forgejo-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

forgejo-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: This documentation describes the Forgejo API.
  title: Forgejo activitypub Settings API
  license:
    name: This file is distributed under the MIT license for the purpose of interoperability
    url: http://opensource.org/licenses/MIT
  version: 16.0.0-dev-465-4b83448b7d+gitea-1.22.0
servers:
- url: /api/v1
security:
- BasicAuth: []
- AuthorizationHeaderToken: []
- SudoParam: []
- SudoHeader: []
- TOTPHeader: []
tags:
- name: settings
paths:
  /settings/api:
    get:
      tags:
      - settings
      summary: Get instance's global settings for api
      operationId: getGeneralAPISettings
      responses:
        '200':
          $ref: '#/components/responses/GeneralAPISettings'
  /settings/attachment:
    get:
      tags:
      - settings
      summary: Get instance's global settings for Attachment
      operationId: getGeneralAttachmentSettings
      responses:
        '200':
          $ref: '#/components/responses/GeneralAttachmentSettings'
  /settings/repository:
    get:
      tags:
      - settings
      summary: Get instance's global settings for repositories
      operationId: getGeneralRepositorySettings
      responses:
        '200':
          $ref: '#/components/responses/GeneralRepoSettings'
  /settings/ui:
    get:
      tags:
      - settings
      summary: Get instance's global settings for ui
      operationId: getGeneralUISettings
      responses:
        '200':
          $ref: '#/components/responses/GeneralUISettings'
components:
  schemas:
    GeneralRepoSettings:
      description: GeneralRepoSettings contains global repository settings exposed by API
      type: object
      properties:
        forks_disabled:
          type: boolean
          x-go-name: ForksDisabled
        http_git_disabled:
          type: boolean
          x-go-name: HTTPGitDisabled
        lfs_disabled:
          type: boolean
          x-go-name: LFSDisabled
        migrations_disabled:
          type: boolean
          x-go-name: MigrationsDisabled
        mirrors_disabled:
          type: boolean
          x-go-name: MirrorsDisabled
        stars_disabled:
          type: boolean
          x-go-name: StarsDisabled
        time_tracking_disabled:
          type: boolean
          x-go-name: TimeTrackingDisabled
      x-go-package: forgejo.org/modules/structs
    GeneralUISettings:
      description: GeneralUISettings contains global ui settings exposed by API
      type: object
      properties:
        allowed_reactions:
          type: array
          items:
            type: string
          x-go-name: AllowedReactions
        custom_emojis:
          type: array
          items:
            type: string
          x-go-name: CustomEmojis
        default_theme:
          type: string
          x-go-name: DefaultTheme
      x-go-package: forgejo.org/modules/structs
    GeneralAPISettings:
      description: GeneralAPISettings contains global api settings exposed by it
      type: object
      properties:
        default_git_trees_per_page:
          type: integer
          format: int64
          x-go-name: DefaultGitTreesPerPage
        default_max_blob_size:
          type: integer
          format: int64
          x-go-name: DefaultMaxBlobSize
        default_paging_num:
          type: integer
          format: int64
          x-go-name: DefaultPagingNum
        max_response_items:
          type: integer
          format: int64
          x-go-name: MaxResponseItems
      x-go-package: forgejo.org/modules/structs
    GeneralAttachmentSettings:
      description: GeneralAttachmentSettings contains global Attachment settings exposed by API
      type: object
      properties:
        allowed_types:
          type: string
          x-go-name: AllowedTypes
        enabled:
          type: boolean
          x-go-name: Enabled
        max_files:
          type: integer
          format: int64
          x-go-name: MaxFiles
        max_size:
          type: integer
          format: int64
          x-go-name: MaxSize
      x-go-package: forgejo.org/modules/structs
  responses:
    GeneralAPISettings:
      description: GeneralAPISettings
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GeneralAPISettings'
        text/html:
          schema:
            $ref: '#/components/schemas/GeneralAPISettings'
    GeneralUISettings:
      description: GeneralUISettings
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GeneralUISettings'
        text/html:
          schema:
            $ref: '#/components/schemas/GeneralUISettings'
    GeneralAttachmentSettings:
      description: GeneralAttachmentSettings
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GeneralAttachmentSettings'
        text/html:
          schema:
            $ref: '#/components/schemas/GeneralAttachmentSettings'
    GeneralRepoSettings:
      description: GeneralRepoSettings
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GeneralRepoSettings'
        text/html:
          schema:
            $ref: '#/components/schemas/GeneralRepoSettings'
  securitySchemes:
    AuthorizationHeaderToken:
      description: API tokens must be prepended with "token" followed by a space.
      type: apiKey
      name: Authorization
      in: header
    BasicAuth:
      type: http
      scheme: basic
    SudoHeader:
      description: Sudo API request as the user provided as the key. Admin privileges are required.
      type: apiKey
      name: Sudo
      in: header
    SudoParam:
      description: Sudo API request as the user provided as the key. Admin privileges are required.
      type: apiKey
      name: sudo
      in: query
    TOTPHeader:
      description: Must be used in combination with BasicAuth if two-factor authentication is enabled.
      type: apiKey
      name: X-FORGEJO-OTP
      in: header