# Assured Workloads API API

> Assured Workloads API API on Apizie: 20 endpoints (Lists the finding summary by category for a given scope., Gets the aggregated compliance report over time for a given scope., Fetches the framework compliance report for a given scope., Lists the control compliance summary for a given scope., …) 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://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-assuredworkloads`
- Category: Analytics
- Status: byok
- Source: https://cloud.google.com/learnmoreurl
- Page: https://zieapi.vercel.app/api/analytics/googleapis-assuredworkloads
- OpenAPI: https://zieapi.vercel.app/api/analytics/googleapis-assuredworkloads/openapi.json



## Endpoints

### Lists the finding summary by category for a given scope.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-projects-locations-db-finding-summaries-lis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. The filtering results. |
| pageSize | integer | no | Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate… |
| pageToken | string | no | Optional. A token that identifies the page of results that the server should return. |
| parent | string | yes | Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} -… |

### Gets the aggregated compliance report over time for a given scope.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-projects-locations-db-framework-compliance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. The filtering results. |
| interval.endTime | string | no | Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. |
| interval.startTime | string | no | Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. |
| name | string | yes | Required. The name of the aggregated compliance report over time to retrieve. Format:… |

### Fetches the framework compliance report for a given scope.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-projects-locations-db-framework-compliance-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endTime | string | no | Optional. The end time of the report. |
| filter | string | no | Optional. The filtering results. |
| name | string | yes | Required. The name of the framework compliance report to retrieve. |

### Lists the control compliance summary for a given scope.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-projects-locations-db-framework-compliance-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. The filtering results. |
| pageSize | integer | no | Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The… |
| pageToken | string | no | Optional. A token that identifies the page of results that the server should return. |
| parent | string | yes | Required. The parent scope for the framework overview page. Format:… |

### Lists the framework compliance summary for a given scope.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-projects-locations-db-framework-compliance-4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. The filtering results. |
| pageSize | integer | no | Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The… |
| pageToken | string | no | Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result. |
| parent | string | yes | Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location}… |
| view | string | no | Optional. Specifies the level of detail to return in the response. |

### Retrieves Assured Workload Violation based on ID.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-violation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the Violation to fetch (ie. Violation.name). Format:… |
| view | string | no | Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for fetching violations. |

### Updates an existing workload. Currently allows updating of workload display_name and labels. For force…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. |
| updateMask | string | no | Required. The list of fields to be updated. |
| body | object | yes | JSON request body |

### Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| etag | string | no | Optional. The etag of the workload. If this is provided, it must match the server's etag. |
| name | string | yes | Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} |

### Lists operations that match the specified filter in the request. If the server doesn't support this method,…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-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… |

### Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-analyze-w` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assetTypes | string | no | Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete… |
| pageSize | integer | no | Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50. |
| pageToken | string | no | Optional. The page token from the previous response. It needs to be passed in the second and following requests. |
| project | string | no | The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID:… |
| target | string | yes | Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be… |

### Lists Assured Workloads under a CRM Node.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported. |
| pageSize | integer | no | Optional. Page size. |
| pageToken | string | no | Optional. Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in… |
| parent | string | yes | Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`. |

### Creates Assured Workload.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | no | Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a… |
| parent | string | yes | Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`. |
| body | object | yes | JSON request body |

### This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-enable-co` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} |

### Enable resource violation monitoring for a workload.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-enable-re` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} |

### Update the permissions settings for an existing partner workload. For force updates don't set etag field in…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-mutate-pa` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} |
| body | object | yes | JSON request body |

### Restrict the list of resources allowed in the Workload environment. The current list of allowed products can…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-restrict` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as… |
| body | object | yes | JSON request body |

### This endpoint creates a new operation to apply the given update.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-updates-a` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the update. Format:… |
| body | object | yes | JSON request body |

### This endpoint lists all updates for the given workload.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-updates-l` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Page size. The default value is 20 and the max allowed value is 100. |
| pageToken | string | no | Page token returned from previous request. |
| parent | string | yes | Required. organizations/{org_id}/locations/{location_id}/workloads/{workload_id} |

### Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-violation-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the Violation to acknowledge. Format:… |
| body | object | yes | JSON request body |

### Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-organizations-locations-workloads-violation-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. A custom filter for filtering by the Violations properties. |
| interval.endTime | string | no | The end of the time window. |
| interval.startTime | string | no | The start of the time window. |
| orderBy | string | no | Optional. Actionable sorting delegation. |
| pageSize | integer | no | Optional. Page size. |
| pageToken | string | no | Optional. Page token returned from previous request. |
| parent | string | yes | Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`. |
| view | string | no | Optional. Specifies the violation view(AssuredWorkloads or DataBoundary) for fetching violations. |

## Example
```
curl "https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-projects-locations-db-finding-summaries-lis" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Assured Workloads API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/analytics:googleapis-assuredworkloads/assuredworkloads-projects-locations-db-finding-summaries-lis with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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