How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Forgejo miscellaneous API

The miscellaneous API from Forgejo — 14 operation(s) for miscellaneous.

Forgejo miscellaneous API is one of 10 APIs that Forgejo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 14 paths, and defines 25 schemas. It is described by OpenAPI 2.0, at version 16.0.0-dev-465-4b83448b7d+gitea-1.22.0.

Requests are made against the base URL https://code.forgejo.org/api/v1.

14 operations 14 paths 25 schemas 11 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
16.0.0-dev-465-4b83448b7d+gitea-1.22.0
Base URL
https://code.forgejo.org/api/v1
Authentication
API Key, basic, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 5

Forgejo miscellaneous API declares 5 security schemes for authenticating requests. An API key is passed in the header as Authorization (AuthorizationHeaderToken). It defines a basic scheme (BasicAuth). An API key is passed in the header as Sudo (SudoHeader). An API key is passed in the query as sudo (SudoParam). An API key is passed in the header as X-FORGEJO-OTP (TOTPHeader). By default, every request must be authenticated.

  • AuthorizationHeaderToken — API tokens must be prepended with "token" followed by a space.
  • SudoHeader — Sudo API request as the user provided as the key. Admin privileges are required.
  • SudoParam — Sudo API request as the user provided as the key. Admin privileges are required.
  • TOTPHeader — Must be used in combination with BasicAuth if two-factor authentication is enabled.

Paths & Operations 14

Across 14 paths, the API surfaces 14 operations — 11 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

miscellaneous 14
GET
/actions/run
Get a workflow run associated with a token
getActionsRun → 200
GET
/gitignore/templates
Returns a list of all gitignore templates
listGitignoresTemplates → 200
GET
/gitignore/templates/{name}
Returns information about a gitignore template
getGitignoreTemplateInfo 1 param → 200404
GET
/label/templates
Returns a list of all label templates
listLabelTemplates → 200
GET
/label/templates/{name}
Returns all labels in a template
getLabelTemplateInfo 1 param → 200404
GET
/licenses
Returns a list of all license templates
listLicenseTemplates → 200
GET
/licenses/{name}
Returns information about a license template
getLicenseTemplateInfo 1 param → 200404
POST
/markdown
Render a markdown document as HTML
renderMarkdown 1 param → 200422
POST
/markdown/raw
Render raw markdown as HTML
renderMarkdownRaw 1 param → 200422
POST
/markup
Render a markup document as HTML
renderMarkup 1 param → 200422
GET
/nodeinfo
Returns the nodeinfo of the Forgejo application
getNodeInfo → 200
GET
/signing-key.gpg
Get default signing-key.gpg
getSigningKey → 200
GET
/signing-key.ssh
Get default signing-key.ssh
getSSHSigningKey → 200404
GET
/version
Returns the version of the running application
getVersion → 200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Repository (66 properties), User (23 properties), ActionRun (23 properties), Organization (12 properties). Each schema is shown below with its type and property counts.

Team
object
Team represents a team in an organization
9 properties
Organization
object
Organization represents an organization
12 properties
Permission
object
Permission represents a set of permissions
3 properties
User
object
User represents a user
23 properties
APIValidationError
object
2 properties
NodeInfoServices
object
NodeInfoServices contains the third party sites this server can connect to via their application API
2 properties
APINotFound
object
3 properties
NodeInfoSoftware
object
NodeInfoSoftware contains Metadata about server software in use
4 properties
Duration
integer
A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to appro…
LicensesTemplateListEntry
object
LicensesListEntry is used for the API
3 properties
ExternalWiki
object
ExternalWiki represents setting for external wiki
1 property
ActionRun
object
ActionRun represents an action run
23 properties
GitignoreTemplateInfo
object
GitignoreTemplateInfo name and text of a gitignore template
2 properties
InternalTracker
object
InternalTracker represents settings for internal tracker
3 properties
LabelTemplate
object
LabelTemplate info of a Label template
4 properties
LicenseTemplateInfo
object
LicensesInfo contains information about a License
5 properties
ServerVersion
object
ServerVersion wraps the version of the server
1 property
ExternalTracker
object
ExternalTracker represents settings for external tracker
4 properties
RepoTransfer
object
RepoTransfer represents a pending repo transfer
3 properties
NodeInfoUsageUsers
object
NodeInfoUsageUsers contains statistics about the users of this server
3 properties
Repository
object
Repository represents a repository
66 properties
NodeInfoUsage
object
NodeInfoUsage contains usage statistics for this server
3 properties
MarkdownOption
object
MarkdownOption markdown options
4 properties
NodeInfo
object
NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks
7 properties
MarkupOption
object
MarkupOption markup options
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

forgejo-miscellaneous-api-openapi.yml Raw ↑

Other APIs Forgejo publishes across the network.

Forgejo activitypub API
Forgejo admin API
Forgejo issue API
Forgejo notification API
Forgejo organization API
Forgejo package API
Forgejo repository API
Forgejo settings API
Forgejo user API
Where this information came from

This is an independent, third-party profile of Forgejo miscellaneous API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.