getConfig
- Print
- PDF
getConfig
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Get settings items for each mailing project. Currently, you can only view blocked delivery history.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /config |
Request headers
For headers common to Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
type | String | Required | Settings item to view
|
subType | String | Optional | Sub type of the setting
|
Request example
The following is a sample request.
curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/config
?type=SEND_BLOCK_TIME'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {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 | Required | Description |
|---|---|---|---|
type | String | Required | Settings item viewed |
subType | Integer | Optional | Sub type of the setting |
value | String | Required | Reflected settings value |
Response status codes
The following describes the response status codes.
| HTTP status code | Code | Description |
|---|---|---|
| 200 | - | Request succeeded |
| 400 | - | Authentication failed, invalid request |
| 400 | 77101 | Error in login information |
| 400 | 77102 | Request error |
| 400 | 77103 | Requested resource does not exist |
| 403 | 77201 | No permissions to the requested resource |
| 403 | 77202 | Call from a user who hasn't subscribed to the email service |
| 405 | 77001 | Unsupported method type |
| 415 | 77002 | Unsupported media type |
| 500 | - | Server error |
| 500 | 77301 | Default project does not exist |
| 500 | 77302 | External system API integration error |
| 500 | 77303 | Other internal server error |
Response example
The following is a sample response.
{
"type": "SEND_BLOCK_TIME",
"subType": null,
"value": "180"
}
Was this article helpful?