# Datastream API API

> Datastream API API on Apizie: 21 endpoints (The FetchStaticIps API call exposes the static IP addresses used by Datastream., Use this method to get details about a stream object., Use this method to update the configuration of a stream., Use this method to delete a stream., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/analytics:googleapis-datastream/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-datastream`
- Category: Analytics
- Status: byok
- Source: https://cloud.google.com/datastream/
- Page: https://apizie.tech/api/analytics/googleapis-datastream
- OpenAPI: https://apizie.tech/api/analytics/googleapis-datastream/openapi.json



## Endpoints

### The FetchStaticIps API call exposes the static IP addresses used by Datastream.
`GET https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-fetch-static-ips` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name for the location for which static IPs should be returned. Must be in the format `projects/*/locations/*`. |
| pageSize | integer | no | Optional. Maximum number of Ips to return, will likely not be specified. |
| pageToken | string | no | Optional. A page token, received from a previous `ListStaticIps` call. will likely not be specified. |

### Use this method to get details about a stream object.
`GET https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-streams-objects-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the stream object resource to get. |

### Use this method to update the configuration of a stream.
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-streams-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| force | boolean | no | Optional. Update the stream without validating it. |
| name | string | yes | Output only. Identifier. The stream's name. |
| requestId | string | no | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to… |
| updateMask | string | no | Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the… |
| validateOnly | boolean | no | Optional. Only validate the stream with the changes, without actually updating it. The default is false. |
| body | object | yes | JSON request body |

### Use this method to delete a stream.
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-streams-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the stream resource to delete. |
| requestId | string | no | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to… |

### Lists information about the supported locations for this service. This method lists locations based on the…
`GET https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| extraLocationTypes | string | no | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter | string | no | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is… |
| name | string | yes | The resource that owns the locations collection, if applicable. |
| pageSize | integer | no | The maximum number of results to return. If not set, the service selects a default. |
| pageToken | string | no | A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |

### Use this method to list connection profiles created in a project and location.
`GET https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-connection-profiles-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Filter request. |
| orderBy | string | no | Optional. Order by fields for the result. |
| pageSize | integer | no | Optional. Maximum number of connection profiles to return. If unspecified, at most 50 connection profiles will be returned. The maximum… |
| pageToken | string | no | Optional. Page token received from a previous `ListConnectionProfiles` call. Provide this to retrieve the subsequent page. When… |
| parent | string | yes | Required. The parent that owns the collection of connection profiles. |

### Use this method to create a connection profile in a project and location.
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-connection-profiles-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| connectionProfileId | string | no | Required. The connection profile identifier. |
| force | boolean | no | Optional. Create the connection profile without validating it. |
| parent | string | yes | Required. The parent that owns the collection of ConnectionProfiles. |
| requestId | string | no | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to… |
| validateOnly | boolean | no | Optional. Only validate the connection profile, but don't create any resources. The default is false. |
| body | object | yes | JSON request body |

### Use this method to discover a connection profile. The discover API call exposes the data objects and…
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-connection-profiles-discover` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent resource of the connection profile type. Must be in the format `projects/*/locations/*`. |
| body | object | yes | JSON request body |

### Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the…
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-operations-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource to be cancelled. |
| body | object | yes | JSON request body |

### Lists operations that match the specified filter in the request. If the server doesn't support this method,…
`GET https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | The standard list filter. |
| name | string | yes | The name of the operation's parent resource. |
| pageSize | integer | no | The standard list page size. |
| pageToken | string | no | The standard list page token. |
| returnPartialSuccess | boolean | no | When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the… |

### Use this method to list private connectivity configurations in a project and location.
`GET https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-private-connections-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Filter request. |
| orderBy | string | no | Optional. Order by fields for the result. |
| pageSize | integer | no | Maximum number of private connectivity configurations to return. If unspecified, at most 50 private connectivity configurations that will… |
| pageToken | string | no | Optional. Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When… |
| parent | string | yes | Required. The parent that owns the collection of private connectivity configurations. |

### Use this method to create a private connectivity configuration.
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-private-connections-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| force | boolean | no | Optional. If set to true, will skip validations. |
| parent | string | yes | Required. The parent that owns the collection of PrivateConnections. |
| privateConnectionId | string | no | Required. The private connectivity identifier. |
| requestId | string | no | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to… |
| validateOnly | boolean | no | Optional. When supplied with PSC Interface config, will get/create the tenant project required for the customer to allow list and won't… |
| body | object | yes | JSON request body |

### Use this method to list routes created for a private connectivity configuration in a project and location.
`GET https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-private-connections-routes-lis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Filter request. |
| orderBy | string | no | Optional. Order by fields for the result. |
| pageSize | integer | no | Optional. Maximum number of Routes to return. The service may return fewer than this value. If unspecified, at most 50 Routes will be… |
| pageToken | string | no | Optional. Page token received from a previous `ListRoutes` call. Provide this to retrieve the subsequent page. When paginating, all other… |
| parent | string | yes | Required. The parent that owns the collection of Routess. |

### Use this method to create a route for a private connectivity configuration in a project and location.
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-private-connections-routes-cre` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent that owns the collection of Routes. |
| requestId | string | no | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to… |
| routeId | string | no | Required. The Route identifier. |
| body | object | yes | JSON request body |

### Use this method to list streams in a project and location.
`GET https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-streams-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Filter request. |
| orderBy | string | no | Optional. Order by fields for the result. |
| pageSize | integer | no | Optional. Maximum number of streams to return. If unspecified, at most 50 streams will be returned. The maximum value is 1000; values… |
| pageToken | string | no | Optional. Page token received from a previous `ListStreams` call. Provide this to retrieve the subsequent page. When paginating, all other… |
| parent | string | yes | Required. The parent that owns the collection of streams. |

### Use this method to create a stream.
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-streams-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| force | boolean | no | Optional. Create the stream without validating it. |
| parent | string | yes | Required. The parent that owns the collection of streams. |
| requestId | string | no | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to… |
| streamId | string | no | Required. The stream identifier. |
| validateOnly | boolean | no | Optional. Only validate the stream, but don't create any resources. The default is false. |
| body | object | yes | JSON request body |

### Use this method to start, resume or recover a stream with a non default CDC strategy.
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-streams-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. Name of the stream resource to start, in the format: projects/{project_id}/locations/{location}/streams/{stream_name} |
| body | object | yes | JSON request body |

### Use this method to list the objects of a specific stream.
`GET https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-streams-objects-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Optional. Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| pageToken | string | no | Optional. Page token received from a previous `ListStreamObjectsRequest` call. Provide this to retrieve the subsequent page. When… |
| parent | string | yes | Required. The parent stream that owns the collection of objects. |

### Use this method to look up a stream object by its source object identifier.
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-streams-objects-lookup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent stream that owns the collection of objects. |
| body | object | yes | JSON request body |

### Use this method to start a backfill job for the specified stream object.
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-streams-objects-start-backfill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| object | string | yes | Required. The name of the stream object resource to start a backfill job for. |
| body | object | yes | JSON request body |

### Use this method to stop a backfill job for the specified stream object.
`POST https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-streams-objects-stop-backfill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| object | string | yes | Required. The name of the stream object resource to stop the backfill job for. |
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-fetch-static-ips" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Datastream API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/analytics:googleapis-datastream/datastream-projects-locations-fetch-static-ips with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Datastream API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Datastream API itself also needs your own key from googleapis.com.

### Can AI agents use the Datastream API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-datastream.

### What is the status of the Datastream API API?
Needs your own provider key (bring your own key)