Skip to navigation
API ReferenceEndpoints

Search endpoints

Searches every application unless applicationId is set.

Requires the inventory:read API key scope.

Authentication

AuthorizationBearer

A workspace API key, sent as Authorization: Bearer.

OR
x-api-keystring

A workspace API key, sent as x-api-key.

Query parameters

qstringRequired1-256 characters
Substring to match.
applicationIdstringOptionalformat: "uuid"
typeenumOptional
authRequiredbooleanOptional
limitintegerOptional1-200
Page size. Defaults to 50.
offsetintegerOptional0-9007199254740991
Results to skip.

Response

A page of matching endpoints.
endpointslist of objects
hasMoreboolean
limitinteger
offsetinteger
querystring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error