# Data Lineage API

- [REST Resource: v1.folders.locations.config](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest#v1.folders.locations.config)
- [REST Resource: v1.organizations.locations.config](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest#v1.organizations.locations.config)
- [REST Resource: v1.projects.locations](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest#v1.projects.locations)
- [REST Resource: v1.projects.locations.config](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest#v1.projects.locations.config)
- [REST Resource: v1.projects.locations.operations](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest#v1.projects.locations.operations)
- [REST Resource: v1.projects.locations.processes](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest#v1.projects.locations.processes)
- [REST Resource: v1.projects.locations.processes.runs](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest#v1.projects.locations.processes.runs)
- [REST Resource: v1.projects.locations.processes.runs.lineageEvents](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest#v1.projects.locations.processes.runs.lineageEvents)

## Service: datalineage.googleapis.com

To call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

### Discovery document

A [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

- <https://datalineage.googleapis.com/$discovery/rest?version=v1>

### Service endpoint

A [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

- `https://datalineage.googleapis.com`

### Regional service endpoint

A regional service endpoint is a base URL that specifies the network address of an API service in a single region. A service that is available in multiple regions might have multiple regional endpoints. Select a location to see its regional service endpoint for this service.
<button value="global" default="">global</button> <button value="africa-south1">africa-south1</button> <button value="asia-east1">asia-east1</button> <button value="asia-east2">asia-east2</button> <button value="asia-northeast1">asia-northeast1</button> <button value="asia-northeast2">asia-northeast2</button> <button value="asia-northeast3">asia-northeast3</button> <button value="asia-south1">asia-south1</button> <button value="asia-south2">asia-south2</button> <button value="asia-southeast1">asia-southeast1</button> <button value="asia-southeast2">asia-southeast2</button> <button value="asia-southeast3">asia-southeast3</button> <button value="australia-southeast1">australia-southeast1</button> <button value="australia-southeast2">australia-southeast2</button> <button value="europe-central2">europe-central2</button> <button value="europe-north1">europe-north1</button> <button value="europe-north2">europe-north2</button> <button value="europe-north3">europe-north3</button> <button value="europe-southwest1">europe-southwest1</button> <button value="europe-west1">europe-west1</button> <button value="europe-west10">europe-west10</button> <button value="europe-west12">europe-west12</button> <button value="europe-west15">europe-west15</button> <button value="europe-west2">europe-west2</button> <button value="europe-west3">europe-west3</button> <button value="europe-west4">europe-west4</button> <button value="europe-west6">europe-west6</button> <button value="europe-west8">europe-west8</button> <button value="europe-west9">europe-west9</button> <button value="me-central1">me-central1</button> <button value="me-central2">me-central2</button> <button value="me-west1">me-west1</button> <button value="northamerica-northeast1">northamerica-northeast1</button> <button value="northamerica-northeast2">northamerica-northeast2</button> <button value="northamerica-south1">northamerica-south1</button> <button value="southamerica-east1">southamerica-east1</button> <button value="southamerica-west1">southamerica-west1</button> <button value="us-central1">us-central1</button> <button value="us-central2">us-central2</button> <button value="us-east1">us-east1</button> <button value="us-east4">us-east4</button> <button value="us-east5">us-east5</button> <button value="us-east7">us-east7</button> <button value="us-south1">us-south1</button> <button value="us-west1">us-west1</button> <button value="us-west2">us-west2</button> <button value="us-west3">us-west3</button> <button value="us-west4">us-west4</button> <button value="us-west8">us-west8</button> <button value="us">us</button> <button value="eu">eu</button>   
- `https://datalineage.googleapis.com`

<br />

## REST Resource: [v1.folders.locations.config](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/folders.locations.config)

| Methods ||
|---|---|
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/folders.locations.config/get` | `GET /v1/{name}` Get the Config for a given resource. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/folders.locations.config/patch` | `PATCH /v1/{config.name}` Update the Config for a given resource. |

## REST Resource: [v1.organizations.locations.config](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/organizations.locations.config)

| Methods ||
|---|---|
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/organizations.locations.config/get` | `GET /v1/{name}` Get the Config for a given resource. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/organizations.locations.config/patch` | `PATCH /v1/{config.name}` Update the Config for a given resource. |

## REST Resource: [v1.projects.locations](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations)

| Methods ||
|---|---|
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations/batchSearchLinkProcesses` | `POST /v1/{parent}:batchSearchLinkProcesses` Retrieve information about LineageProcesses associated with specific links. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations/processOpenLineageRunEvent` | `POST /v1/{parent}:processOpenLineageRunEvent` Creates new lineage events together with their parents: process and run. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations/searchLineageStreaming` | `POST /v1/{parent}:searchLineageStreaming` Retrieves a streaming response of lineage links connected to the requested assets by performing a breadth-first search in the given direction. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations/searchLinks` | `POST /v1/{parent}:searchLinks` Retrieve a list of links connected to a specific asset. |

## REST Resource: [v1.projects.locations.config](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.config)

| Methods ||
|---|---|
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.config/get` | `GET /v1/{name}` Get the Config for a given resource. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.config/patch` | `PATCH /v1/{config.name}` Update the Config for a given resource. |

## REST Resource: [v1.projects.locations.operations](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.operations)

| Methods ||
|---|---|
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.operations/cancel` | `POST /v1/{name}:cancel` Starts asynchronous cancellation on a long-running operation. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.operations/delete` | `DELETE /v1/{name}` Deletes a long-running operation. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.operations/get` | `GET /v1/{name}` Gets the latest state of a long-running operation. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.operations/list` | `GET /v1/{name}/operations` Lists operations that match the specified filter in the request. |

## REST Resource: [v1.projects.locations.processes](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes)

| Methods ||
|---|---|
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes/create` | `POST /v1/{parent}/processes` Creates a new process. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes/delete` | `DELETE /v1/{name}` Deletes the process with the specified name. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes/get` | `GET /v1/{name}` Gets the details of the specified process. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes/list` | `GET /v1/{parent}/processes` List processes in the given project and location. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes/patch` | `PATCH /v1/{process.name}` Updates a process. |

## REST Resource: [v1.projects.locations.processes.runs](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs)

| Methods ||
|---|---|
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs/create` | `POST /v1/{parent}/runs` Creates a new run. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs/delete` | `DELETE /v1/{name}` Deletes the run with the specified name. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs/get` | `GET /v1/{name}` Gets the details of the specified run. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs/list` | `GET /v1/{parent}/runs` Lists runs in the given project and location. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs/patch` | `PATCH /v1/{run.name}` Updates a run. |

## REST Resource: [v1.projects.locations.processes.runs.lineageEvents](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs.lineageEvents)

| Methods ||
|---|---|
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs.lineageEvents/create` | `POST /v1/{parent}/lineageEvents` Creates a new lineage event. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs.lineageEvents/delete` | `DELETE /v1/{name}` Deletes the lineage event with the specified name. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs.lineageEvents/get` | `GET /v1/{name}` Gets details of a specified lineage event. |
| `https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/projects.locations.processes.runs.lineageEvents/list` | `GET /v1/{parent}/lineageEvents` Lists lineage events in the given project and location. |