Data Sources

Operations for disabling, enabling, and renaming individual data sources

Each cloud provider will have one or more associated data sources. Each represents a discrete instance of a service that Veza connects to for the discovery and extraction of authorization metadata.

The provider under /providers/aws/{id}, for example, may have an associated EC2 data source, represented as:

{
  "id": "6961b032-3fd7-4baa-a230-146d1b70ec27",
  "name": "AWS EC2 (527398259632)",
  "datasource_type": "EXTRACTOR",
  "agent_type": "AWS_EC2",
  "status": "SUCCESS",
  "provider_id": "cd0cf102-e86c-4599-9cbe-64d2c6b83236",
  "path": "AWS/ec2",
  "state": "ENABLED",
  "effective_state": "ENABLED",
  "datasource_config": null,
  "created_at": "2021-10-26T07:10:38Z",
  "updated_at": "2021-10-26T07:10:38Z",
  "synced_at": "2022-01-13T20:53:23Z",
  "parsed_at": "2022-01-13T20:53:29Z"
}

You can use the API to get or update data source records, or enable and disable individual data sources.

Disabling a data source will cancel all pending extractions.

List Data Sources

List Data Sources

GET {{VezaUrl}}/api/v1/providers/datasources

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

For example: ?filter=datasource_type+eq+"discoverer"&order_by=state

Veza expects spaces in URLS encoded as + (?custom_template+eq+"idp"&order_by=state). Note that some libraries and clients will encode spaces as %2B by default, which will cause errors unless you override this behavior.

* indicates a required field.

Query Parameters

Name	Type	Description
filter	string	When present, only returns data sources matching the filter string. Available options: name , agent_type , status , state , name , provider_id , data_provider_id , datasource_type
order_by	string	Sort results by name , agent_type , status , state , name , provider_id , data_provider_id , or datasource_type .
page_size	int	The maximum number of results to return. Fewer results may be returned even when more pages exist.
page_token	string	The token specifying the specific page of results to retrieve.

200: OK A successful response

{
  "values": [
    {
      "id": "string",
      "name": "string",
      "datasource_type": "string",
      "agent_type": "string",
      "status": "string",
      "provider_id": "string",
      "path": "string",
      "state": "string",
      "effective_state": "string",
      "created_at": "string",
      "updated_at": "string",
      "synced_at": "string",
      "parsed_at": "string"
    }
  ],
  "next_page_token": "ec67g",
  "has_more": false
}

Get Data Source

Get Data Source

GET {{VezaUrl}}/api/v1/providers/datasources/{id}

Returns status for an individual data source.

* indicates a required field.

Path Parameters

Name	Type	Description
id*	string	The data source ID

200: OK A successful response

{
  "value": {
    "id": "string",
    "name": "string",
    "datasource_type": "string",
    "agent_type": "string",
    "status": "string",
    "provider_id": "string",
    "path": "string",
    "state": "string",
    "effective_state": "string",
    "created_at": "string",
    "updated_at": "string",
    "synced_at": "string",
    "parsed_at": "string"
  }
}

Update Data Source

Update Data Source

PUT {{VezaUrl}}/api/v1/providers/datasources/{id}

Update the name for a given data source ID.

* indicates a required field.

Path Parameters

Name	Type	Description
id*	string	The data source ID

Request Body

Name	Type	Description
name	string	New name for the data source

200: OK A successful response

{
  "value": {
    "id": "string",
    "name": "string",
    "datasource_type": "string",
    "agent_type": "string",
    "status": "string",
    "provider_id": "string",
    "path": "string",
    "state": "string",
    "effective_state": "string",
    "created_at": "string",
    "updated_at": "string",
    "synced_at": "string",
    "parsed_at": "string"
  }
}

Enable or Disable Providers

Disable Data Source

PUT {{VezaUrl}}/api/v1/providers/datasources/{id}:disable

Pause discovery and extraction for a data source.

* indicates a required field.

Path Parameters

Name	Type	Description
id*	string	The data source ID

200: OK A successful response

{}

Enable Data Source

PUT {{VezaUrl}}/api/v1/providers/datasources/{id}:enable

Resume monitoring and queue the data source for extraction.

* indicates a required field.

Path Parameters

Name	Type	Description
id	string	The data source ID

200: OK A successful response

{}

providers/custom

See Open Authorization API and [OAA Operations](.../../oaa/rest-api/operations.md.