getTriggers

Available in VPC

Get the list of triggers.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/v1/triggers

Request headers

For information about the headers common to all Data Flow APIs, see Data Flow request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`name`	String	Optional	Trigger name
`page`	Integer	Optional	Page number 0-N (default: 0)
`limit`	Integer	Optional	Page output count 0-N (default: 1000)

Request example

The request example is as follows:

curl --location --request GET 'https://dataflow.apigw.ntruss.com/api/v1/triggers?page=0&limit=1000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`list`	Array	-	Trigger list
`count`	Integer	-	Number of response results
`page`	Integer	-	Page number
`limit`	Integer	-	Page output count

`list`

The following describes list.

Field	Type	Required	Description
`triggerId`	String	-	Trigger ID
`name`	String	-	Trigger name
`type`	String	-	Trigger execution option type `SCHEDULED` \| `NONE` `SCHEDULED`: Run on a cycle or specific date. `NONE`: no execution option
`triggerRule`	Object	-	Trigger execution option information
`triggerRule.type`	String	-	Trigger execution option type `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: Run on a cycle. `ONE_TIME`: Run on a specific date. `NONE`: no execution option
`triggerRule.interval`	String	-	Trigger execution cycle `HOUR` \| `DAY` \| `WEEK` \| `MONTH` `HOUR`: every hour `DAY`: every day `WEEK`: every week `MONTH`: every month Displayed if `triggerRule.type` is `RECURRING`
`triggerRule.time`	String	-	Trigger repeat execution time (minute or time) Displayed if `triggerRule.type` is `RECURRING` Display the minutes to repeat in if `triggerRule.interval` is `HOUR` (00-59). Display the time to repeat in if `triggerRule.interval` is `DAY`, `WEEK`, or `MONTH`.
`triggerRule.dayOfWeek[]`	Array	-	Trigger repeat execution day of the week `MONDAY` \| `TUESDAY` \| `WEDNESDAY` \| `THURSDAY` \| `FRIDAY` \| `SATURDAY` \| `SUNDAY` Displayed if `triggerRule.interval` is `WEEK`
`triggerRule.dateOfMonth`	String	-	Trigger repeat execution date Date between 1 and 31; -1 (last date of every month) Displayed if `triggerRule.interval` is `MONTH`
`triggerRule.executionDate`	String	-	Trigger execution date and time Displayed if `triggerRule.type` is `ONE_TIME`
`createdDate`	String	-	Trigger creation date and time ISO 8601 format (including UTC+9)
`updatedDate`	String	-	Trigger modification date and time ISO 8601 format (including UTC+9)

Response status codes

For response status codes common to all Data Flow APIs, see Data Flow API response status codes.

Response example

The response example is as follows:

{
  "list" : [ {
    "triggerId" : "d125za******",
    "name" : "trigger001",
    "type" : "SCHEDULED",
    "triggerRule" : {
      "type" : "RECURRING",
      "interval" : "DAY",
      "time" : "08:00"
    },
    "createdDate" : "2025-03-19T17:22:46+09:00",
    "updatedDate" : "2025-03-19T17:22:46+09:00"
  }, {
    "triggerId" : "7AydJf******",
    "name" : "trigger",
    "type" : "NONE",
    "triggerRule" : {
      "type" : "NONE"
    },
    "createdDate" : "2025-03-19T16:16:39+09:00",
    "updatedDate" : "2025-03-19T16:16:39+09:00"
  } ],
  "count" : 2,
  "page" : 0,
  "limit" : 1000
}