Console
    Contact Us Start free

    Method: projects.locations.jobs.list

    Lists jobs.

    HTTP request

    GET https://cloudscheduler.googleapis.com/v1beta1/{parent=projects/*/locations/*}/jobs

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    parent

    string

    Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID .

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

    • cloudscheduler.jobs.list

    Query parameters

    Parameters
    filter

    string

    filter can be used to specify a subset of jobs.

    If filter equals target_config="HttpConfig" , then the http target jobs are retrieved. If filter equals target_config="PubSubConfig" , then the Pub/Sub target jobs are retrieved. If filter equals labels.foo=value1 labels.foo=value2 then only jobs which are labeled with foo=value1 AND foo=value2 will be returned.
    pageSize

    integer

    Requested page size.

    The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use nextPageToken to determine if more jobs exist.
    pageToken

    string

    A token identifying a page of results the server will return. To request the first page results, pageToken must be empty. To request the next page of results, pageToken must be the value of nextPageToken returned from the previous call to jobs.list . It is an error to switch the value of filter or orderBy while iterating through pages.
    legacyAppEngineCron

    boolean

    This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the jobs in the __cron queue will be listed instead.

    Request body

    The request body must be empty.

    Response body

    Response message for listing jobs using jobs.list .

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "jobs" 
 : 
 [ 
 { 
 object (  Job 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    jobs[]

    object ( Job )

    The list of jobs.
    nextPageToken

    string

    A token to retrieve next page of results. Pass this value in the pageToken field in the subsequent call to jobs.list to retrieve the next page of results. If this is empty it indicates that there are no more results through which to paginate.

    The page token is valid for only 2 hours.

    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 .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: