Method: projects.locations.jobs.run

Forces a job to run now.

When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

HTTP request

POST https://cloudscheduler.googleapis.com/v1/{name=projects/*/locations/*/jobs/*}:run

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

Authorization requires the following IAM permission on the specified resource name:

  • cloudscheduler.jobs.run

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Job.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-scheduler

For more information, see the Authentication Overview.