Get trigger
- Print
- PDF
Get trigger
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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 | /triggers/{triggerName} |
Request headers
For headers common to all Cloud Functions APIs, see Cloud Functions common headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
triggerName | String | Required | Trigger name |
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
platform | String | Optional | Platform type
|
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 | Object[] | 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
The following describes the response status codes.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| 400 | 80502 | TRIGGER_PLATFORM_MISMATCH | Invalid platform parameter |
| 403 | 80002 | SUB_ACC_NO_PERMISSION | Detailed permission error |
| 404 | 80501 | TRIGGER_NOT_FOUND | Trigger not found |
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"
}
}
Was this article helpful?