Get a service

Returns full manifest metadata for a service, including configuration and secrets schemas.

GET /services/{serviceId}

Get a service

cURL

curl --request GET \
  --url http://localhost:9371/services/{serviceId}

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "hash": "<string>",
  "source": "<string>",
  "adapter": "<string>",
  "enabled": true,
  "stale": true,
  "effectivelyEnabled": true,
  "configSchema": {},
  "secretsSchema": {}
}

Path Parameters

serviceId · string · required

Service identifier matching the installed manifest id.

Minimum string length: 1

Response

200

application/json

Service details.

Service metadata including configuration and secrets schemas.

id · string · required

Service identifier used as the manifest primary key.

Minimum string length: 1

name · string · required

Display name declared by the service manifest.

Minimum string length: 1

description · string · required

Human-readable description of the service.

hash · string · required

Content hash of the installed manifest definition.

Minimum string length: 1

source · string · required

Install source used to fetch the manifest definition.

Minimum string length: 1

adapter · string · required

Adapter module identifier that owns the service.

Minimum string length: 1

enabled · boolean · required

Whether the service is currently enabled.

stale · boolean · required

Whether the service needs to be synced. Stale services cannot be enabled or invoked.

effectivelyEnabled · boolean · required

Whether the service is actually usable considering its own enabled state, its parent module's state, and whether the module is missing.

configSchema · object · required

JSON Schema describing the service configuration object.

Show child attributes

secretsSchema · object · required

JSON Schema describing the service secrets object.

Show child attributes