Workload Manager API

Workload Manager is a service that provides tooling for enterprise workloads to automate the deployment and validation of your workloads against best practices and recommendations.

Service: workloadmanager.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. 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 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 documents:

Service endpoint

A 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://workloadmanager.googleapis.com

REST Resource: v1alpha.projects.locations

Methods
get GET /v1alpha/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1alpha/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1alpha.projects.locations.deployments

Methods
create POST /v1alpha/{parent=projects/*/locations/*}/deployments
Creates a new Deployment in a given project and location.
delete DELETE /v1alpha/{name=projects/*/locations/*/deployments/*}
Deletes a single Deployment.
get GET /v1alpha/{name=projects/*/locations/*/deployments/*}
Gets details of a single Deployment.
list GET /v1alpha/{parent=projects/*/locations/*}/deployments
Lists Deployments in a given project and location.
patch PATCH /v1alpha/{deployment.name=projects/*/locations/*/deployments/*}
Updates the parameters of a single Deployment.

REST Resource: v1alpha.projects.locations.deployments.actuations

Methods
create POST /v1alpha/{parent=projects/*/locations/*/deployments/*}/actuations
Creates a new actuation for an existing Deployment.
delete DELETE /v1alpha/{name=projects/*/locations/*/deployments/*/actuations/*}
Deletes a single Actuation
get GET /v1alpha/{name=projects/*/locations/*/deployments/*/actuations/*}
Gets details of a single Actuation.
list GET /v1alpha/{parent=projects/*/locations/*/deployments/*}/actuations
Lists Actuations in a given project, location and deployment.

REST Resource: v1alpha.projects.locations.deployments.actuations.ansibleTasks

Methods
get GET /v1alpha/{name=projects/*/locations/*/deployments/*/actuations/*/ansibleTasks/*}
Gets details of a single Actuation.
list GET /v1alpha/{parent=projects/*/locations/*/deployments/*/actuations/*}/ansibleTasks
Lists AnsibleTasks in a given project, location, deployment and actuation

REST Resource: v1alpha.projects.locations.operations

Methods
cancel POST /v1alpha/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1alpha/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1alpha/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1alpha/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.evaluations

Methods
create POST /v1/{parent=projects/*/locations/*}/evaluations
Creates a new Evaluation in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/evaluations/*}
Deletes a single Evaluation.
get GET /v1/{name=projects/*/locations/*/evaluations/*}
Gets details of a single Evaluation.
list GET /v1/{parent=projects/*/locations/*}/evaluations
Lists Evaluations in a given project and location.
patch PATCH /v1/{evaluation.name=projects/*/locations/*/evaluations/*}
Updates the parameters of a single Evaluation.

REST Resource: v1.projects.locations.evaluations.executions

Methods
delete DELETE /v1/{name=projects/*/locations/*/evaluations/*/executions/*}
Deletes a single Execution.
get GET /v1/{name=projects/*/locations/*/evaluations/*/executions/*}
Gets details of a single Execution.
list GET /v1/{parent=projects/*/locations/*/evaluations/*}/executions
Lists Executions in a given project and location.
run POST /v1/{name=projects/*/locations/*/evaluations/*}/executions:run
Creates a new Execution in a given project and location.

REST Resource: v1.projects.locations.evaluations.executions.results

Methods
list GET /v1/{parent=projects/*/locations/*/evaluations/*/executions/*}/results
List the running result of a single Execution.

REST Resource: v1.projects.locations.evaluations.executions.scannedResources

Methods
list GET /v1/{parent=projects/*/locations/*/evaluations/*/executions/*}/scannedResources
List all scanned resources for a single Execution.

REST Resource: v1.projects.locations.insights

Methods
writeInsight POST /v1/{location=projects/*/locations/*}/insights:writeInsight
Write the data insights to workload manager data warehouse.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.rules

Methods
list GET /v1/{parent=projects/*/locations/*}/rules
Lists rules in a given project.