Home

Overview

This is a set of documents which describes Gogs API usage, since it's still in early stage:

1. Content of documentation is subject to change.
2. We do not provide documentation in other languages.

If you have any questions or concern, please file an issue. 😊

Current Version

All Gogs APIs are under v1 using request path prefix /api/v1.

Authentication

There 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.

Basic Authentication

$ curl -u "unknwon" https://try.gogs.io/api/v1/users/unknwon/tokens

Basic authentication can be used for all Gogs APIs.

Access Token

Personal access tokens are easier to manage and use, but except for few APIs(e.g. API to generate or get a access token), and they MUST be sent in header.

$ curl -H "Authorization: token ACCESS-TOKEN" https://try.gogs.io/api/v1/user/repos