API Usage

HoyoShip serves its API at /api/v1. The endpoints listed in HoyoShip’s published compatibility profile stay compatible in every HoyoShip release. Endpoints specific to HoyoShip, such as its version endpoint, are served under /api/hoyoship/v1.

Warning

The following instructions use hoyoship.example.org as placeholder for the HoyoShip instance URL and other placeholders, such as {yourusername} and {yourpassword}, which need to be replaced before running these commands.

Enabling/configuring API access

By default, the API is enabled on HoyoShip instances, but instance administrators may choose to disable it.

Authentication

HoyoShip supports these methods of API authentication:

• HTTP basic authentication
• Authorization: Bearer ... header in HTTP headers
• Authorization: token ... header in HTTP headers

Generating and listing API tokens

A new token can be generated with a POST request to /users/:name/tokens.

Note that /users/:name/tokens is a special endpoint and requires you to authenticate using BasicAuth and a password, as follows:

$ curl -H "Content-Type: application/json" -d '{"name":"test","scopes":["write:package"]}' -u {yourusername}:{yourpassword} https://hoyoship.example.org/api/v1/users/{username}/tokens
{"id":1,"name":"test","sha1":"9fcb1158165773dd010fca5f0cf7174316c3e37d","token_last_eight":"16c3e37d","scopes":["write:package"]}

The keys of the JSON data object are name (the display name for the token) and scopes (list of Access Token scope names).

The sha1 (the token) is only returned once and is not stored in plain-text. It will not be displayed when listing tokens with a GET request; e.g.

$ curl --url https://{yourusername}:{yourpassword}@hoyoship.example.org/api/v1/users/{username}/tokens
[{"name":"test","sha1":"","token_last_eight":"........"},{"name":"dev","sha1":"","token_last_eight":"........"}]

To use the API with basic authentication with two factor authentication (2FA) enabled, you’ll need to send an additional header that contains the one-time password (6-digit rotating token). An example of the header is X-Forgejo-OTP: 123456 where 123456 is where you’d place the code from your authenticator. Here is how the request would look like in curl:

$ curl -H "X-Forgejo-OTP: 123456" --url https://{yourusername}:{yourpassword}@hoyoship.example.org/api/v1/users/{username}/tokens

You can also create an API key token via your HoyoShip installation’s web interface: Settings | Applications | Generate New Token.

OAuth2 Provider

Access tokens obtained from HoyoShip’s OAuth2 provider are accepted by these methods:

• Authorization: Bearer ... header in HTTP headers
• token=... parameter in URL query string
• access_token=... parameter in URL query string

More on the Authorization: header

For historical reasons, HoyoShip needs the word token included before the API key token in an authorization header, like this:

Authorization: token 65eaa9c8ef52460d22a93307fe0aee76289dc675

In a curl command, for instance, this would look like:

curl "https://hoyoship.example.org/api/v1/repos/test1/test1/issues" \
    -H "accept: application/json" \
    -H "Authorization: token 65eaa9c8ef52460d22a93307fe0aee76289dc675" \
    -H "Content-Type: application/json" -d "{ \"body\": \"testing\", \"title\": \"test 20\"}" -i

As mentioned above, the token used is the same one you would use in the token= string in a GET request.

Sudo

The API allows admin users to sudo API requests as another user. Simply add either a sudo= parameter or Sudo: request header with the username of the user to sudo.

Pagination

The API supports pagination. The page and limit parameters are used to specify the page number and the number of items per page. As well, the Link header is returned with the next, previous, and last page links if there are more than one page. The x-total-count is also returned to indicate the total number of items.

curl -v "https://hoyoship.example.org/api/v1/repos/search?limit=1"
...
< link: <https://hoyoship.example.org/api/v1/repos/search?limit=1&page=2>; rel="next",<https://hoyoship.example.org/api/v1/repos/search?limit=1&page=5252>; rel="last"
...
< x-total-count: 5252

The default and maximum values for the page parameter can be obtained from the https://hoyoship.example.org/api/v1/settings/api endpoint.

$ curl https://hoyoship.example.org/api/v1/settings/api
{
  "max_response_items": 50,
  "default_paging_num": 30,
  "default_git_trees_per_page": 1000,
  "default_max_blob_size": 10485760
}

API Guide

API Reference guide is auto-generated by Swagger and available on: https://hoyoship.example.org/api/swagger.

The OpenAPI document is at: https://hoyoship.example.org/swagger.v1.json