Get trigger

Prev Next

Available in Classic and VPC

View a Cloud Functions trigger.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET /ncf/api/v2/triggers/{triggerName}

Request headers

For information about the headers common to all Cloud Functions APIs, see Cloud Functions request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
triggerName String Required Trigger name

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
platform String Optional Platform type
  • vpc (default) | classic

Request example

The following is a sample request.

curl -X GET 'https://cloudfunctions.apigw.ntruss.com/ncf/api/v2/triggers/{triggerName}?platform=vpc' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Description
content.actions String[] List of actions associated with the trigger
content.description String Description of the trigger
content.execOption Array Execution option by trigger type
content.name String Trigger name
content.resourceId String Trigger's resource ID
content.type String Trigger type

Response status codes

For information about the HTTP status codes common to all Cloud Functions APIs, see Cloud Functions response status codes.

Response example

The following is a sample response.

{
    "content": {
        "actions": [
            "myaction"
        ],
        "description": "My GitHub trigger",
        "execOption": [
            {
                "key": "events",
                "value": "*"
            }
        ],
        "name": "my_github_trigger",
        "resourceId": "NSRoF",
        "type": "github"
    }
}