CTctrlplanedev
Resources

Search resources

Changed on

Returns a paginated list of resources matching the given filters.

post/v1/workspaces/{workspaceId}/resources/search

Request

  • Base URL
    http://localhost:3001/api
  • URL
    http://localhost:3001/api/v1/workspaces/{workspaceId}/resources/search
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

workspaceIdstring required

ID of the workspace

Request body

identifiersstring[]
kindsstring[]
limitinteger
metadataobject

Exact metadata key/value matches

offsetinteger
order'asc' | 'desc'
providerIdsstring[]
querystring

Text search on name or identifier

sortBy'createdAt' | 'updatedAt' | 'name' | 'kind'
versionsstring[]

Response

Matching resources

limitinteger required

Maximum number of items returned

offsetinteger required

Number of items skipped

totalinteger required

Total number of items available

Changes