---
title: "Get external engine"
method: GET
path: "/api/external-engine/{id}"
tags: ["External engine"]
---

# Get external engine

`GET /api/external-engine/{id}`

Get properties and credentials of an external engine.

## Response `200`

A registered engine.

- ExternalEngine
  - `id` string, required — Unique engine registration ID.
  - `name` string, required — Display name of the engine.
  - `clientSecret` string, required — A secret token that can be used to [*request* analysis](#tag/external-engine/POST/api/external-engine/{id}/analyse) from this external engine.
  - `userId` string, required — The user this engine has been registered for.
  - `maxThreads` integer, required — Maximum number of available threads.
  - `maxHash` integer, required — Maximum available hash table size, in MiB.
  - `variants` UciVariant[], required — List of supported chess variants.
  - `providerData` string, nullable — Arbitrary data that the engine provider can use for identification or bookkeeping. Users can read this information, but updating it requires knowing or changing the `providerSecret`.

---

[API](https://skmtc.net/lichess/apis/lichess-org-api-reference.md) · [All operations](https://skmtc.net/lichess/apis/lichess-org-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lichess/lichess-org-api-reference/versions/1425db81eb3b/schema)