Cloud Run Admin API (run:v1)

2026-01-22

9 new methods

Additions

    Methods
  • run.namespaces.instances.list

      Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/instances

      Parameter Order : parent

      Path : apis/run.googleapis.com/v1/{+parent}/instances

      Parameters :

        watch

          Description : Optional. Not supported by Cloud Run.

          Type : boolean

          Location : query

        limit

          Description : Optional. The maximum number of records that should be returned.

          Type : integer

          Location : query

          Format : int32

        labelSelector

          Type : string

          Description : Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

          Location : query

        parent

          Required : Yes

          Type : string

          Description : Required. The namespace from which the Instances should be listed. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID

          Location : path

          Pattern : ^namespaces/[^/]+$

        fieldSelector

          Description : Optional. Not supported by Cloud Run.

          Type : string

          Location : query

        resourceVersion

          Location : query

          Type : string

          Description : Optional. Not supported by Cloud Run.

        includeUninitialized

          Type : boolean

          Location : query

          Description : Optional. Not supported by Cloud Run.

        continue

          Location : query

          Description : Optional. Optional encoded string to continue paging.

          Type : string

      Description : List Instances. Results are sorted by creation time, descending.

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

      HTTP Method : GET

  • run.namespaces.instances.stop

      Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/instances/{instancesId}:stop

      Parameters :

        name

          Required : Yes

          Location : path

          Pattern : ^namespaces/[^/]+/instances/[^/]+$

          Description : Required. The name of the Instance to run. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID

          Type : string

      Path : apis/run.googleapis.com/v1/{+name}:stop

      HTTP Method : POST

      Parameter Order : name

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

      Description : Stop an Instance that is running.

  • run.namespaces.instances.create

      Description : Create a Instance.

      HTTP Method : POST

      Parameters :

        parent

          Location : path

          Pattern : ^namespaces/[^/]+$

          Description : Required. The namespace in which the Instance should be created. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID

          Type : string

          Required : Yes

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

      Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/instances

      Parameter Order : parent

      Path : apis/run.googleapis.com/v1/{+parent}/instances

  • run.namespaces.instances.start

      Parameters :

        name

          Required : Yes

          Type : string

          Description : Required. The name of the Instance to run. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID

          Pattern : ^namespaces/[^/]+/instances/[^/]+$

          Location : path

      HTTP Method : POST

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

      Parameter Order : name

      Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/instances/{instancesId}:start

      Description : Start an Instance which has been stopped.

      Path : apis/run.googleapis.com/v1/{+name}:start

  • run.namespaces.instances.delete

      Description : Delete a Instance.

      HTTP Method : DELETE

      Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/instances/{instancesId}

      Parameters :

        name

          Description : Required. The name of the Instance to delete. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID

          Pattern : ^namespaces/[^/]+/instances/[^/]+$

          Required : Yes

          Type : string

          Location : path

        apiVersion

          Location : query

          Description : Optional. Cloud Run currently ignores this parameter.

          Type : string

        propagationPolicy

          Description : Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.

          Type : string

          Location : query

        kind

          Location : query

          Description : Optional. Cloud Run currently ignores this parameter.

          Type : string

      Parameter Order : name

      Path : apis/run.googleapis.com/v1/{+name}

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

  • run.namespaces.instances.get

      HTTP Method : GET

      Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/instances/{instancesId}

      Parameters :

        name

          Location : path

          Pattern : ^namespaces/[^/]+/instances/[^/]+$

          Required : Yes

          Description : Required. The name of the Instance to retrieve. It takes the form namespaces/{namespace}/instances/{Instance_name} and the `endpoint` must be regional. Replace {namespace} with the project ID or number.

          Type : string

      Description : Get an Instance.

      Parameter Order : name

      Path : apis/run.googleapis.com/v1/{+name}

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

  • run.projects.locations.instances.testIamPermissions

      Parameter Order : resource

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions

      HTTP Method : POST

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

      Parameters :

        resource

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

          Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Location : path

          Required : Yes

          Type : string

      Description : Returns permissions that a caller has on the specified instance. There are no permissions required for making this API call.

      Path : v1/{+resource}:testIamPermissions

  • run.projects.locations.instances.setIamPolicy

      Parameter Order : resource

      Parameters :

        resource

          Location : path

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

          Required : Yes

          Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type : string

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy

      Description : Sets the IAM Access control policy for the specified instance. Overwrites any existing policy.

      Path : v1/{+resource}:setIamPolicy

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

  • run.projects.locations.instances.getIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy

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

      Parameter Order : resource

      Description : Get the IAM Access Control policy currently in effect for the given instance. This result does not include any inherited policies.

      HTTP Method : GET

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type : string

          Required : Yes

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

          Location : path

        options.requestedPolicyVersion

          Type : integer

          Format : int32

          Location : query

          Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

      Path : v1/{+resource}:getIamPolicy