{"id":13603045,"url":"https://github.com/gogs/docs-api","last_synced_at":"2025-10-04T18:39:31.630Z","repository":{"id":43679987,"uuid":"161859640","full_name":"gogs/docs-api","owner":"gogs","description":"A repository for Gogs API v1 documentation.","archived":false,"fork":false,"pushed_at":"2024-08-19T21:02:27.000Z","size":39,"stargazers_count":140,"open_issues_count":17,"forks_count":31,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-08-11T06:56:13.639Z","etag":null,"topics":["api","documentation","gogs"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gogs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-12-15T01:48:51.000Z","updated_at":"2025-05-23T08:16:34.000Z","dependencies_parsed_at":"2025-09-01T08:01:17.868Z","dependency_job_id":null,"html_url":"https://github.com/gogs/docs-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gogs/docs-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gogs%2Fdocs-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gogs%2Fdocs-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gogs%2Fdocs-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gogs%2Fdocs-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gogs","download_url":"https://codeload.github.com/gogs/docs-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gogs%2Fdocs-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278358302,"owners_count":25973944,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","documentation","gogs"],"created_at":"2024-08-01T18:01:47.590Z","updated_at":"2025-10-04T18:39:31.566Z","avatar_url":"https://github.com/gogs.png","language":null,"funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"# Overview\n\nThis is a set of documents which describes Gogs REST API v1 usage, since it's still in early stage:\n\n1. Content of documentation and APIs are subject to change.\n2. We do not provide documentation in other languages.\n3. Aim to be in the format that is similar to [GitHub REST API v3](https://developer.github.com/v3/).\n\nIf you have any questions or concern, please [file an issue](https://github.com/gogs/go-gogs-client/issues/new). :blush:\n\n## TOC\n\n- [Administration](Administration)\n  - [Users](Administration/Users.md)\n  - [Repositories](Administration/Repositories.md)\n  - [Organizations](Administration/Organizations.md)\n  - [Teams](Administration/Teams.md)\n- [Issues](Issues)\n  - [Comments](Issues/Comments.md)\n  - [Labels](Issues/Labels.md)\n  - [Milestones](Issues/Milestones.md)\n- [Miscellaneous](Miscellaneous)\n- [Organizations](Organizations)\n  - [Members](Organizations/Members.md)\n  - [Teams](Organizations/Teams.md)\n- [Repositories](Repositories)\n  - [Branches](Repositories/Branches.md)\n  - [Collaborators](Repositories/Collaborators.md)\n  - [Commits](Repositories/Commits.md)\n  - [Contents](Repositories/Contents.md)\n  - [Deploy Keys](Repositories/Deploy%20Keys.md)\n  - [Releases](Repositories/Releases.md)\n  - [Webhooks](Repositories/Webhooks.md)\n- [Users](Users)\n  - [Emails](Users/Emails.md)\n  - [Followers](Users/Followers.md)\n  - [Public Keys](Users/Public%20Keys.md)\n- [Git Data](Git%20Data)\n  - [Trees](Git%20Data/Trees.md)\n\n## Installation \n\nThe API is preinstalled with the base Gogs deployment. See [current version](#current-version) and [API source code](https://github.com/gogs/gogs/tree/master/internal/route/api) for more details.\n\n## Current Version\n\nAll Gogs APIs are under **v1** using request path prefix `/api/v1`.\n\n## Schema\n\nAll data is sent and received as JSON unless specified otherwise.\n\n```\nHTTP/2 200\ncontent-type: application/json; charset=UTF-8\ndate: Sat, 15 Dec 2018 01:55:28 GMT\nserver: Caddy\ncontent-length: 175\n```\n\nAll timestamps return in RFC3339 format:\n\n```\nYYYY-MM-DDTHH:MM:SSZ\n2006-01-02T15:04:05Z07:00\n```\n\n## Authentication\n\nThere are three ways to authenticate through Gogs API v1. Requests that require authentication will return `404 Not Found`, instead of `403 Forbidden`, in some places. This is to prevent the accidental leakage of private repositories to unauthorized users.\n\n## Basic Authentication\n\n```\ncurl -u \"unknwon\" https://try.gogs.io/api/v1/users/unknwon/tokens\n```\n\nBasic authentication can only be used to obtain access tokens.\n\n### Access Token\n\nPersonal access tokens are easier to manage and use, but except for few APIs (i.e. generate or get a access token), and they can be sent in **header** or **URL query**.\n\n```\n$ curl -H \"Authorization: token {ACCESS_TOKEN}\" https://try.gogs.io/api/v1/user/repos\n$ curl https://try.gogs.io/api/v1/user/repos?token={ACCESS_TOKEN}\n```\n\n## Pagination\n\nYou can specify further pages with the `?page` parameter.\n\n```\ncurl https://try.gogs.io/api/v1/repos/unknwon/hello/issues?page=1\n```\n\nNote that page numbering is 1-based and that omitting the `?page` parameter will return the first page.\n\n### Link header\n\nThe [Link header](http://tools.ietf.org/html/rfc5988) includes pagination information:\n\n```\nLink: \u003chttps://try.gogs.io/api/v1/repos/unknwon/hello/issues?page=3\u003e; rel=\"next\",\n  \u003chttps://try.gogs.io/api/v1/repos/unknwon/hello/issues?page=50\u003e; rel=\"last\"\n```\n\nThe example includes a line break for readability.\n\nThis Link response header contains one or more Hypermedia link relations, some of which may require expansion as URI templates.\n\nThe possible rel values are:\n\n|Name|Description|\n|----|-----------|\n|`next`|The link relation for the immediate next page of results.|\n|`last`|The link relation for the last page of results.|\n|`first`|The link relation for the first page of results.|\n|`prev`|The link relation for the immediate previous page of results.|\n\n## Clients\n\n- [Go](https://github.com/gogs/go-gogs-client)\n- [Android](https://github.com/unfoldingWord-dev/android-gogs-client)\n- [Bash](https://github.com/grogorick/gogs-cli)\n\n## Notes\n\n- The style of documentation is heavily influenced by [GitHub Developer](https://developer.github.com/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgogs%2Fdocs-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgogs%2Fdocs-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgogs%2Fdocs-api/lists"}