Workload Manager API (workloadmanager:v1)

2026-02-14

8 new methods

Additions

    Methods
  • workloadmanager.projects.locations.deployments.get

      Path : v1/{+name}

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        name

          Location : path

          Type : string

          Description : Required. Name of the resource. The format will be 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'

          Pattern : ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$

          Required : Yes

      Description : Gets details of a single Deployment.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}

      HTTP Method : GET

  • workloadmanager.projects.locations.deployments.delete

      Description : Deletes a single Deployment.

      Path : v1/{+name}

      Parameters :

        name

          Type : string

          Location : path

          Required : Yes

          Description : Required. Name of the resource

          Pattern : ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$

        force

          Location : query

          Description : Optional. If set to true, any actuation will also be deleted. Followed the best practice from https://aip.dev/135#cascading-delete

          Type : boolean

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

      HTTP Method : DELETE

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}

  • workloadmanager.projects.locations.deployments.create

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments

      Parameters :

        deploymentId

          Location : query

          Description : Required. Id of the deployment

          Type : string

        requestId

          Type : string

          Location : query

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

        parent

          Required : Yes

          Location : path

          Type : string

          Description : Required. The resource prefix of the Deployment using the form: `projects/{project_id}/locations/{location_id}`

          Pattern : ^projects/[^/]+/locations/[^/]+$

      Parameter Order : parent

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+parent}/deployments

      Description : Creates a new Deployment in a given project and location.

  • workloadmanager.projects.locations.deployments.list

      Parameters :

        orderBy

          Location : query

          Type : string

          Description : Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

        pageSize

          Description : Optional. Requested page size. Server may return fewer items than requested. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Type : integer

          Format : int32

          Location : query

        parent

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Description : Required. The resource prefix of the Deployment using the form: `projects/{project_id}/locations/{location_id}`

          Type : string

          Required : Yes

        filter

          Location : query

          Description : Optional. Filter resource follow https://google.aip.dev/160

          Type : string

        pageToken

          Location : query

          Type : string

          Description : Optional. A token identifying a page of results the server should return.

      Path : v1/{+parent}/deployments

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : parent

      Description : Lists Deployments in a given project and location.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments

  • workloadmanager.projects.locations.deployments.actuations.create

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations

      Path : v1/{+parent}/actuations

      Description : Creates a new actuation for an existing Deployment.

      Parameters :

        requestId

          Type : string

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

        parent

          Pattern : ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$

          Location : path

          Description : Required. The resource name of the Actuation location using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}'

          Type : string

          Required : Yes

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : POST

  • workloadmanager.projects.locations.deployments.actuations.get

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations/{actuationsId}

      Path : v1/{+name}

      Parameter Order : name

      Parameters :

        name

          Description : Required. Name of the resource

          Type : string

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/deployments/[^/]+/actuations/[^/]+$

          Location : path

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets details of a single Actuation.

  • workloadmanager.projects.locations.deployments.actuations.delete

      Path : v1/{+name}

      Parameters :

        name

          Description : Required. The name of the book to delete. project/{project_id}/locations/{location_id}/deployments/{deployment_id}/actuations/{actuation_id}

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/deployments/[^/]+/actuations/[^/]+$

          Required : Yes

          Type : string

      Description : Deletes a single Actuation

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations/{actuationsId}

      HTTP Method : DELETE

  • workloadmanager.projects.locations.deployments.actuations.list

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+parent}/actuations

      Description : Lists Actuations in a given project, location and deployment.

      Parameters :

        parent

          Location : path

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$

          Required : Yes

          Description : Required. The resource prefix of the Actuation using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}'

        pageSize

          Format : int32

          Location : query

          Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

          Type : integer

        filter

          Description : Optional. Filtering results

          Type : string

          Location : query

        pageToken

          Type : string

          Location : query

          Description : Optional. A token identifying a page of results the server should return.

        orderBy

          Location : query

          Type : string

          Description : Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations

      Parameter Order : parent