List Data Sources

Retrieve all data sources with optional filtering and pagination

Endpoint

GET /api/v1/providers/datasources

Description

Returns the properties and status for all data sources. When filtering is applied, only data sources matching the filter will be returned.

Data sources represent discrete instances of services that Veza connects to for discovery and extraction of authorization metadata. Each cloud provider may have one or more associated data sources.

API Reference

get
Authorizations
AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Query parameters
filterstringOptional

When specified, only data sources matching the filter will be returned. Valid attributes: datasource_type Valid operators: EQ E.g. 'datasource_type eq "extractor"'

order_bystringOptional
page_sizeinteger ยท int32Optional

The maximum number of results to be returned. Fewer results may be returned even when more pages exist.

page_tokenstringOptional

The token specifying the specific page of results to retrieve.

Responses
chevron-right
200

OK

application/json
get
/api/v1/providers/datasources

Query Parameters

Parameter
Type
Required?
Description

filter

string

Optional

When present, only returns data sources matching the filter. Available options: name, agent_type, status, state, provider_id, data_provider_id, datasource_type

order_by

string

Optional

Sort results by: name, agent_type, status, state, provider_id, data_provider_id, or datasource_type

page_size

integer

Optional

The maximum number of results to return. Fewer results may be returned even when more pages exist

page_token

string

Optional

The token specifying the specific page of results to retrieve

Request Examples

circle-info

Veza expects spaces in URLs encoded as + (?datasource_type+eq+"extractor"). Some libraries encode spaces as %2B by default, which will cause errors.

Response Examples

Standard Response:

Last updated

Was this helpful?