Skip to main content
GET
cURL

Query Parameters

projectId
string

The ID of the Agent Vault project.

Required string length: 1 - 36
requiresSetup
enum<string>

true lists only the services that still need your personal values; false leaves them out. Leave it out to list both.

Available options:
true,
false
granted
enum<string>

true lists only services in access bundles granted to you, leaving out ones an admin reaches only through their role.

Available options:
true
orderBy
enum<string>
default:name

What to sort services by: name, type, or createdAt.

Available options:
name,
type,
createdAt
orderDirection
enum<string>
default:asc

The sort direction, asc or desc.

Available options:
asc,
desc

Only services whose name, description or host pattern contains this text.

Maximum string length: 255
Pattern: ^[^\x00-\x1f\x7f]*$
limit
integer
default:20

The number of services to return.

Required range: 1 <= x <= 100
offset
integer
default:0

The number of services to skip.

Required range: 0 <= x <= 10000

Response

Default Response

services
(HTTP · object | MCP · object | PostgreSQL · object | MySQL · object | SSH · object)[]
required
totalCount
number
required

The number of services that match, across every page.