get /triggers

Lists currently scheduled monetization jobs. See also Viewing scheduled jobs using the API.

Notes:

  • Apigee Edge Private Cloud customers only. You must have system admin privileges to use the APIs. Apigee Edge Cloud customers should contact Apigee Support for assistance with managing the monetization job schedule.
  • This API cannot be executed using the Try this API panel.

HTTP request

https://api.enterprise.apigee.com/v1/triggers

Query Parameters

orgid (required)

string

Name of your organization.

Response Types

200: 

OK

Body

application/json
ScheduledJobs
scheduled-job

array

Details of the scheduled job.

ScheduledJob
createdDate

integer

Output only. Job creation date in epoch format.

cronExpression

string

Cron expression to create a firing schedule for the trigger, such as: At 8:00 A.M. every Monday through Friday or At 1:30 A.M. every last Friday of the month. Specifying this property defines the trigger as a cron trigger. See also Building cron expressions.

endTime

integer

Time in epoch format when the trigger's schedule is no longer in effect.

enabled

boolean

Flag that indicates whether the trigger is enabled to execute. Set this value to true to enable execution of the trigger.

group

string

Type of server in which the trigger will execute. For example, if the trigger is supposed to execute in a management server, the value should be set to management-server. If the trigger is supposed to execute in a message processing server, the value should be set to message-processor.

id

string

ID of the trigger.

jobId

string

ID of the job that is to be executed.

name

string

Unique name used to identify the trigger.

priority

string

Relative firing priority of the triggers if multiple triggers are scheduled to execute at the same. The lower the value, the higher the priority. For example, if two triggers are scheduled to execute at the same time, and if one trigger has a priority of 1 and the other a priority of 2, the trigger with priority 1 executes first. This property applies only if multiple triggers have exactly the same firing time.

startTime

integer

Time in epoch format when the trigger's schedule goes into effect. Note: Applies to simple triggers only.

suiteId

string

Flag that specifies whether the notification part of the system-level or default-level suite of notifications. Valid values are DEFAULT or SYSTEM, or you can specify your own unique suite name.

triggerDataMap

object

custom_lock_key

string

Lock key that prevents multiple servers from executing the same job at the same time.

updatedDate

integer

Date job was last updated in epoch format.

Authentication Requirements

Available Authentication Options
  • Basic
  • OAuth

Try this API

Request parameters
orgid
Credentials
Multi-factor authentication is not supported.