List services

Returns the installed services. The query parameter is trimmed and matched against service id, name, and description. The enabled and stale parameters accept ‘true’ or ‘false’; omit either to return all services.

GET /services

List services

cURL

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

200

{
  "services": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "hash": "<string>",
      "source": "<string>",
      "adapter": "<string>",
      "enabled": true,
      "stale": true,
      "effectivelyEnabled": true
    }
  ]
}

Query Parameters

query · string

Free-text query used to match service id, name, and description.

enabled · enum<string>

Enabled-state filter. Omit to return all services.

Available options: true, false

stale · enum<string>

Stale-state filter. true = stale only, false = fresh only. Omit to return all services.

Available options: true, false

Response

200

application/json

Matching services.

Collection wrapper for service listings.

services · object[] · required

Services that match the current query filters.

Show child attributes