Cloud Run Admin API

Service: run.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:

    Global endpoint

    https://run.googleapis.com
    • For v2:
      • This is the preferred endpoint for all methods.
      • Global list (e.g. using "-" as region) is not supported.
      • Regional endpoints are also supported.
    • For v1, this endpoint only supports Global List: use regional endpoints instead.

    Regional endpoints

    For v2, regional endpoints are supported, and region must match the location in the method path.
    For v1, regional endpoints are required.

      REST Resource: v2.projects.locations.jobs

      Methods
      createPOST /v2/{parent}/jobs
      Creates a Job.
      deleteDELETE /v2/{name}
      Deletes a Job.
      getGET /v2/{name}
      Gets information about a Job.
      getIamPolicyGET /v2/{resource}:getIamPolicy
      Gets the IAM Access Control policy currently in effect for the given Job.
      listGET /v2/{parent}/jobs
      Lists Jobs.
      patchPATCH /v2/{job.name}
      Updates a Job.
      runPOST /v2/{name}:run
      Triggers creation of a new Execution of this Job.
      setIamPolicyPOST /v2/{resource}:setIamPolicy
      Sets the IAM Access control policy for the specified Job.
      testIamPermissionsPOST /v2/{resource}:testIamPermissions
      Returns permissions that a caller has on the specified Project.

      REST Resource: v2.projects.locations.jobs.executions

      Methods
      cancelPOST /v2/{name}:cancel
      Cancels an Execution.
      deleteDELETE /v2/{name}
      Deletes an Execution.
      getGET /v2/{name}
      Gets information about an Execution.
      listGET /v2/{parent}/executions
      Lists Executions from a Job.

      REST Resource: v2.projects.locations.jobs.executions.tasks

      Methods
      getGET /v2/{name}
      Gets information about a Task.
      listGET /v2/{parent}/tasks
      Lists Tasks from an Execution of a Job.

      REST Resource: v2.projects.locations.operations

      Methods
      deleteDELETE /v2/{name}
      Deletes a long-running operation.
      getGET /v2/{name}
      Gets the latest state of a long-running operation.
      listGET /v2/{name}/operations
      Lists operations that match the specified filter in the request.
      waitPOST /v2/{name}:wait
      Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.

      REST Resource: v2.projects.locations.services

      Methods
      createPOST /v2/{parent}/services
      Creates a new Service in a given project and location.
      deleteDELETE /v2/{name}
      Deletes a Service.
      getGET /v2/{name}
      Gets information about a Service.
      getIamPolicyGET /v2/{resource}:getIamPolicy
      Gets the IAM Access Control policy currently in effect for the given Cloud Run Service.
      listGET /v2/{parent}/services
      Lists Services.
      patchPATCH /v2/{service.name}
      Updates a Service.
      setIamPolicyPOST /v2/{resource}:setIamPolicy
      Sets the IAM Access control policy for the specified Service.
      testIamPermissionsPOST /v2/{resource}:testIamPermissions
      Returns permissions that a caller has on the specified Project.

      REST Resource: v2.projects.locations.services.revisions

      Methods
      deleteDELETE /v2/{name}
      Deletes a Revision.
      getGET /v2/{name}
      Gets information about a Revision.
      listGET /v2/{parent}/revisions
      Lists Revisions from a given Service, or from a given location.

      REST Resource: v2.projects.locations.workerPools

      Methods
      createPOST /v2/{parent}/workerPools
      Creates a new WorkerPool in a given project and location.
      deleteDELETE /v2/{name}
      Deletes a WorkerPool.
      getGET /v2/{name}
      Gets information about a WorkerPool.
      listGET /v2/{parent}/workerPools
      Lists WorkerPools.
      patchPATCH /v2/{workerPool.name}
      Updates a WorkerPool.
      testIamPermissionsPOST /v2/{resource}:testIamPermissions
      Returns permissions that a caller has on the specified Project.

      REST Resource: v2.projects.locations.workerPools.revisions

      Methods
      deleteDELETE /v2/{name}
      Deletes a Revision.
      getGET /v2/{name}
      Gets information about a Revision.
      listGET /v2/{parent}/revisions
      Lists Revisions from a given Service, or from a given location.

      REST Resource: v1.namespaces.authorizeddomains

      Methods
      listGET /apis/domains.cloudrun.com/v1/{parent}/authorizeddomains
      List authorized domains.

      REST Resource: v1.namespaces.configurations

      Methods
      getGET /apis/serving.knative.dev/v1/{name}
      Get information about a configuration.
      listGET /apis/serving.knative.dev/v1/{parent}/configurations
      List configurations.

      REST Resource: v1.namespaces.domainmappings

      Methods
      createPOST /apis/domains.cloudrun.com/v1/{parent}/domainmappings
      Create a new domain mapping.
      deleteDELETE /apis/domains.cloudrun.com/v1/{name}
      Delete a domain mapping.
      getGET /apis/domains.cloudrun.com/v1/{name}
      Get information about a domain mapping.
      listGET /apis/domains.cloudrun.com/v1/{parent}/domainmappings
      List all domain mappings.

      REST Resource: v1.namespaces.executions

      Methods
      cancelPOST /apis/run.googleapis.com/v1/{name}:cancel
      Cancel an execution.
      deleteDELETE /apis/run.googleapis.com/v1/{name}
      Delete an execution.
      getGET /apis/run.googleapis.com/v1/{name}
      Get information about an execution.
      listGET /apis/run.googleapis.com/v1/{parent}/executions
      List executions.

      REST Resource: v1.namespaces.jobs

      Methods
      createPOST /apis/run.googleapis.com/v1/{parent}/jobs
      Create a job.
      deleteDELETE /apis/run.googleapis.com/v1/{name}
      Delete a job.
      getGET /apis/run.googleapis.com/v1/{name}
      Get information about a job.
      listGET /apis/run.googleapis.com/v1/{parent}/jobs
      List jobs.
      replaceJobPUT /apis/run.googleapis.com/v1/{name}
      Replace a job.
      runPOST /apis/run.googleapis.com/v1/{name}:run
      Trigger creation of a new execution of this job.

      REST Resource: v1.namespaces.revisions

      Methods
      deleteDELETE /apis/serving.knative.dev/v1/{name}
      Delete a revision.
      getGET /apis/serving.knative.dev/v1/{name}
      Get information about a revision.
      listGET /apis/serving.knative.dev/v1/{parent}/revisions
      List revisions.

      REST Resource: v1.namespaces.routes

      Methods
      getGET /apis/serving.knative.dev/v1/{name}
      Get information about a route.
      listGET /apis/serving.knative.dev/v1/{parent}/routes
      List routes.

      REST Resource: v1.namespaces.services

      Methods
      createPOST /apis/serving.knative.dev/v1/{parent}/services
      Creates a new Service.
      deleteDELETE /apis/serving.knative.dev/v1/{name}
      Deletes the provided service.
      getGET /apis/serving.knative.dev/v1/{name}
      Gets information about a service.
      listGET /apis/serving.knative.dev/v1/{parent}/services
      Lists services for the given project and region.
      replaceServicePUT /apis/serving.knative.dev/v1/{name}
      Replaces a service.

      REST Resource: v1.namespaces.tasks

      Methods
      getGET /apis/run.googleapis.com/v1/{name}
      Get information about a task.
      listGET /apis/run.googleapis.com/v1/{parent}/tasks
      List tasks.

      REST Resource: v1.namespaces.workerpools

      Methods
      createPOST /apis/run.googleapis.com/v1/{parent}/workerpools
      Creates a new WorkerPool.
      deleteDELETE /apis/run.googleapis.com/v1/{name}
      Deletes the provided worker pool.
      getGET /apis/run.googleapis.com/v1/{name}
      Gets information about a worker pool.
      listGET /apis/run.googleapis.com/v1/{parent}/workerpools
      Lists worker pools for the given project and region.
      replaceWorkerPoolPUT /apis/run.googleapis.com/v1/{name}
      Replaces a worker pool.

      REST Resource: v1.projects.locations

      Methods
      listGET /v1/{name}/locations
      Lists information about the supported locations for this service.

      REST Resource: v1.projects.locations.jobs

      Methods
      getIamPolicyGET /v1/{resource}:getIamPolicy
      Get the IAM Access Control policy currently in effect for the given job.
      setIamPolicyPOST /v1/{resource}:setIamPolicy
      Sets the IAM Access control policy for the specified job.
      testIamPermissionsPOST /v1/{resource}:testIamPermissions
      Returns permissions that a caller has on the specified job.

      REST Resource: v1.projects.locations.services

      Methods
      getIamPolicyGET /v1/{resource}:getIamPolicy
      Gets the IAM Access Control policy currently in effect for the given Cloud Run service.
      setIamPolicyPOST /v1/{resource}:setIamPolicy
      Sets the IAM Access control policy for the specified Service.
      testIamPermissionsPOST /v1/{resource}:testIamPermissions
      Returns permissions that a caller has on the specified Project.