Google

Assured Workloads API

Assured Workloads API endpoints from Google

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Assured Workloads API endpoints from Google

Endpoints 15

organizations.locations.workloads.violations

  • GETRetrieves an Assured Workloads violation by its resource name./v1/:name?view=VIOLATION_VIEW_UNSPECIFIEDRetrieves an Assured Workloads violation by its resource name.
  • POSTAcknowledges an existing violation/v1/:name:acknowledgeAcknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to…
  • GETLists the Violations in the AssuredWorkload Environment/v1/:parent/violations?filter=string&interval.endTime=string&interval.startTime=string&orderBy=string&pageSize=0&pageToken=string&view=VIOLATION_VIEW_UNSPECIFIEDLists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per AIP-159 by using '-' (the hyphen or…

organizations.locations.workloads

  • DELETEDeletes the workload/v1/:name?etag=stringDeletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION…
  • PATCHUpdates an existing workload/v1/:name?updateMask=stringUpdates 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…
  • GETAnalyzes a hypothetical move of a source resource to a target workload to surface compliance risks/v1/:target:analyzeWorkloadMove?assetTypes=string&pageSize=0&pageToken=string&project=stringAnalyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be…
  • GETLists Assured Workloads under a CRM Node./v1/:parent/workloads?filter=string&pageSize=0&pageToken=stringLists Assured Workloads under a CRM Node.
  • POSTCreates Assured Workload./v1/:parent/workloads?externalId=stringCreates Assured Workload.
  • PUTThis endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload/v1/:name:enableComplianceUpdatesThis endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service…
  • POSTEnable resource violation monitoring for a workload./v1/:name:enableResourceMonitoringEnable resource violation monitoring for a workload.
  • PATCHUpdate the permissions settings for an existing partner workload/v1/:name:mutatePartnerPermissionsUpdate the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per…
  • POSTRestrict the list of resources allowed in the Workload environment/v1/:name:restrictAllowedResourcesRestrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at…

organizations.locations.operations

  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

organizations.locations.workloads.updates

  • POSTThis endpoint creates a new operation to apply the given update./v1/:name:applyThis endpoint creates a new operation to apply the given update.
  • GETThis endpoint lists all updates for the given workload./v1/:parent/updates?pageSize=0&pageToken=stringThis endpoint lists all updates for the given workload.

API details

Base URL
https://assuredworkloads.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 3 scopes
An API key in the key query parameter
Operations
15 operations on 12 pathsGET 6POST 5PATCH 2PUT 1DELETE 1
Main resources
organizations.locations.workloads 9organizations.locations.workloads.violations 3organizations.locations.workloads.updates 2organizations.locations.operations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Assured Workloads API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Assured Workloads API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieves an Assured Workloads violation by its resource name.” (GET /v1/:name?view=VIOLATION_VIEW_UNSPECIFIED), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Assured Workloads API?

Assured Workloads API endpoints from Google It is listed under Developer tools and has 15 endpoints.

Who publishes the Assured Workloads API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Assured Workloads API?

Requests go to https://assuredworkloads.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Assured Workloads API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 3 scopes; an API key in the key query parameter.

How many endpoints does the Assured Workloads API have?

15 operations on 12 paths (6 GET, 5 POST, 2 PATCH, 1 PUT, 1 DELETE). The largest groups are organizations.locations.workloads, organizations.locations.workloads.violations, organizations.locations.workloads.updates, organizations.locations.operations.

Is forking the Assured Workloads API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.