Get a service

Returns the manifest metadata, hashes, and schema documents for the requested service.

GET /services/{serviceName}

Get a service

cURL

curl --request GET \
  --url http://localhost:7687/services/{serviceName}

200

{
  "name": "<string>",
  "type": "<string>",
  "source": "<string>",
  "description": "<string>",
  "hash": "<string>",
  "enabled": true,
  "configSchema": {},
  "secretsSchema": {}
}

Path Parameters

serviceName · string · required

Normalized service name.

Minimum string length: 1

Response

200

application/json

Service details.

Complete service metadata payload returned by the service detail endpoint.

name · string · required

Normalized service name used as the manifest identifier.

Minimum string length: 1

type · string · required

Service adapter type declared by the manifest.

Minimum string length: 1

source · string · required

Normalized source used to install or update the manifest.

Minimum string length: 1

description · string · required

Human-readable service description.

hash · string · required

Content hash of the installed manifest definition.

Minimum string length: 1

enabled · boolean · required

Whether the service is enabled for staging and execution.

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