APIHub
Back to Explore

Assured Workloads API

Assured Workloads API

Analytics
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
GET

/v1beta1/{name}

Retrieves Assured Workload Violation based on ID.

  • name (path, required) — Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}
DELETE

/v1beta1/{name}

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

  • name (path, required) — Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}
  • etag (query) — Optional. The etag of the workload. If this is provided, it must match the server's etag.
PATCH

/v1beta1/{name}

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

  • name (path, required) — Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
  • updateMask (query) — Required. The list of fields to be updated.
GET

/v1beta1/{name}/operations

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • name (path, required) — The name of the operation's parent resource.
  • filter (query) — The standard list filter.
  • pageSize (query, limit) — The standard list page size.
  • pageToken (query) — The standard list page token.
POST

/v1beta1/{name}:acknowledge

Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.

  • name (path, required) — Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}
POST

/v1beta1/{name}:restrictAllowedResources

Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.

  • name (path, required) — Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1".
GET

/v1beta1/{parent}/violations

Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`

  • parent (path, required) — Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.
  • filter (query) — Optional. A custom filter for filtering by the Violations properties.
  • interval.endTime (query) — The end of the time window.
  • interval.startTime (query) — The start of the time window.
  • pageSize (query, limit) — Optional. Page size.
  • pageToken (query) — Optional. Page token returned from previous request.
GET

/v1beta1/{parent}/workloads

Lists Assured Workloads under a CRM Node.

  • parent (path, required) — Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.
  • filter (query) — A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.
  • pageSize (query, limit) — Page size.
  • pageToken (query) — Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.
POST

/v1beta1/{parent}/workloads

Creates Assured Workload.

  • parent (path, required) — Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.
  • externalId (query) — Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.
GET

/v1beta1/{project}/{target}:analyzeWorkloadMove

Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.

  • project (path, required) — The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.
  • target (path, required) — Required. The resource ID of the folder-based destination workload. This workload is where the source project will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2"
  • source (query) — The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-1"
GET

/v1beta1/{source}/{target}:analyzeWorkloadMove

Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.

  • source (path, required) — The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-1"
  • target (path, required) — Required. The resource ID of the folder-based destination workload. This workload is where the source project will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2"
  • project (query) — The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.

11 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://assuredworkloads.googleapis.com/v1beta1/{name}"

assuredworkloads.googleapis.com · HTTPS only