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…
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
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.
Endpoints 19
projects.locations.operations
- GETGets the latest state of a long-running operation
/v1/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - DELETEDeletes a long-running operation
/v1/:nameDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If… - POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - 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.
projects.locations.evaluations
- PATCHUpdates the parameters of a single Evaluation.
/v1/:name?requestId=string&updateMask=stringUpdates the parameters of a single Evaluation. - GETLists Evaluations in a given project and location.
/v1/:parent/evaluations?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Evaluations in a given project and location. - POSTCreates a new Evaluation in a given project and location.
/v1/:parent/evaluations?evaluationId=string&requestId=stringCreates a new Evaluation in a given project and location.
projects.locations
- GETLists information about the supported locations for this service
/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…
projects.locations.deployments
- GETLists Deployments in a given project and location.
/v1/:parent/deployments?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Deployments in a given project and location. - POSTCreates a new Deployment in a given project and location.
/v1/:parent/deployments?deploymentId=string&requestId=stringCreates a new Deployment in a given project and location.
projects.locations.deployments.actuations
- GETLists Actuations in a given project, location and deployment.
/v1/:parent/actuations?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Actuations in a given project, location and deployment. - POSTCreates a new actuation for an existing Deployment.
/v1/:parent/actuations?requestId=stringCreates a new actuation for an existing Deployment.
projects.locations.discoveredprofiles
- GETList discovered workload profiles
/v1/:parent/discoveredprofiles?filter=string&pageSize=0&pageToken=stringList discovered workload profiles
projects.locations.evaluations.executions
- GETLists Executions in a given project and location.
/v1/:parent/executions?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Executions in a given project and location. - POSTCreates a new Execution in a given project and location.
/v1/:name/executions:runCreates a new Execution in a given project and location.
projects.locations.evaluations.executions.results
- GETLists the result of a single evaluation.
/v1/:parent/results?filter=string&pageSize=0&pageToken=stringLists the result of a single evaluation.
projects.locations.evaluations.executions.scannedResources
- GETList all scanned resources for a single Execution.
/v1/:parent/scannedResources?filter=string&orderBy=string&pageSize=0&pageToken=string&rule=stringList all scanned resources for a single Execution.
projects.locations.insights
- POSTWrite the data insights to workload manager data warehouse.
/v1/:location/insights:writeInsightWrite the data insights to workload manager data warehouse.
projects.locations.rules
- GETLists rules in a given project.
/v1/:parent/rules?customRulesBucket=string&evaluationType=EVALUATION_TYPE_UNSPECIFIED&filter=string&pageSize=0&pageToken=stringLists rules in a given project.
API details
- Base URL
https://workloadmanager.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 19 operations on 14 pathsGET 11POST 6PATCH 1DELETE 1
- Main resources
- projects.locations.operations 4projects.locations.evaluations 3projects.locations.deployments 2projects.locations.deployments.actuations 2projects.locations.evaluations.executions 2projects.locations 1projects.locations.discoveredprofiles 1projects.locations.evaluations.executions.results 1projects.locations.evaluations.executions.scannedResources 1projects.locations.insights 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Workload Manager API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Workload Manager API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 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… It is listed under Developer tools and has 19 endpoints.
Who publishes the Workload Manager 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 Workload Manager API?
Requests go to https://workloadmanager.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Workload Manager API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Workload Manager API have?
19 operations on 14 paths (11 GET, 6 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.operations, projects.locations.evaluations, projects.locations.deployments, projects.locations.deployments.actuations.
Is forking the Workload Manager API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.