List the extensions the user can install

GET

/api/v1/extensions

const url = 'http://localhost:8080/api/v1/extensions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/extensions \
  --header 'Authorization: Bearer <token>'

Every extension in the indexes of the repositories that are usable.

Authorizations

session
basic

Responses

200

The extensions.

application/json

object

items

required

Array<object>

object

installedVersion

required

The version the user installed from this repository, if any.

string | null

repositoryId

required

integer format: int64

required

The extension’s reverse-DNS id, such as org.example.comics.

string

name

required

string

version

required

string

sites

required

Hosts the extension may reach, such as api.example.org or *.example.org.

Array<string>

languages

required

BCP 47 tags of the languages the source serves; empty for any.

Array<string>

capabilities

required

What the extension needs beyond plain requests. browser means it uses the server’s browser solver, set with CHEK_BROWSER_SOLVER_URL, to get past challenges such as Cloudflare’s. browser-session uses an interactive Chromium session, configured with CHEK_BROWSER_EXECUTABLE. image-transform lets the extension transform fetched images before they are cached and served.

Array<string>

formats

required

The formats the extension’s chapters come in, so clients know which readers it needs before opening a chapter. Sources from before formats existed read images.

Array<string>

>= 1 items

Allowed values: images epub pdf

Example

{
  "items": [
    {
      "formats": [
        "images"
      ]
    }
  ]
}

401

The request has no valid session token.

application/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

500

The server failed; details are in its log.

application/json

object

code

required

string

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}