cdn_notifications
GET
List CDN notifications.
- Auth. Required:
Yes
- Roles Required:
Read-Only
- Permissions Required:
CDN:READ
- Response Type:
Array
Request Structure
Parameter |
Required |
Description |
---|---|---|
cdn |
no |
The CDN name of the notifications you wish to retrieve. |
id |
no |
The integral, unique identifier of the notification you wish to retrieve. |
user |
no |
The username of the user responsible for creating the CDN notifications. |
GET /api/4.0/cdn_notifications HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...
Response Structure
- id:
The integral, unique identifier of the notification
- cdn:
The name of the CDN to which the notification belongs to
- lastUpdated:
The time and date this server entry was last updated in RFC 3339 format
- notification:
The content of the notification
- user:
The user responsible for creating the notification
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 02 Dec 2019 22:51:14 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: F2NmDbTpXqrIQDX7IBKH9+1drtTL4XedSfJv6klMgLEZwbLCkddIXuSLpmgVCID6kTVqy3fTKjZS3U+HJ3YUEQ==
X-Server-Name: traffic_ops_golang/
Date: Mon, 02 Dec 2019 21:51:14 GMT
Content-Length: 128
{ "response": [
{
"id": 42,
"cdn": "cdn1",
"lastUpdated": "2019-12-02T21:49:08Z",
"notification": "the content of the notification",
"user": "username123",
}
]}
POST
Creates a notification for a specific CDN.
Note
Currently only one notification per CDN is supported.
- Auth. Required:
Yes
- Roles Required:
“admin” or “operations”
- Permissions Required:
CDN:UPDATE
- Response Type:
Object
Request Structure
- cdn:
The name of the CDN to which the notification shall belong
- notification:
The content of the notification
POST /api/4.0/cdn_notifications HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...
Content-Length: 29
{"cdn": "cdn1", "notification": "the content of the notification"}
Response Structure
- id:
The integral, unique identifier of the notification
- cdn:
The name of the CDN to which the notification belongs to
- lastUpdated:
The time and date this server entry was last updated in RFC 3339 format
- notification:
The content of the notification
- user:
The user responsible for creating the notification
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 02 Dec 2019 22:49:08 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: mx8b2GTYojz4QtMxXCMoQyZogCB504vs0yv6WGly4dwM81W3XiejWNuUwchRBYYi8QHaWsMZ3DaiGGfQi/8Giw==
X-Server-Name: traffic_ops_golang/
Date: Mon, 02 Dec 2019 21:49:08 GMT
Content-Length: 150
{
"alerts":
[
{
"text": "notification was created.",
"level": "success"
}
],
"response":
{
"id": 42,
"cdn": "cdn1",
"lastUpdated": "2019-12-02T21:49:08Z",
"notification": "the content of the notification",
"user": "username123",
}
}
DELETE
Deletes an existing CDN notification.
- Auth. Required:
Yes
- Roles Required:
“admin” or “operations”
- Permissions Required:
CDN:UPDATE
- Response Type:
undefined
Request Structure
Parameter |
Required |
Description |
---|---|---|
id |
yes |
The integral, unique identifier of the notification you wish to delete. |
DELETE /api/4.0/cdn_notifications?id=42 HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...
Content-Length: 0
Response Structure
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Tue, 25 Feb 2020 08:27:33 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: Woz8NSHIYVpX4V5X4xZWZIX1hvGL2uian7nUhjZ8F23Nb9RWQRMIg/cc+1vXEzkT/ehKV9t11FKRLX+avSae0g==
X-Server-Name: traffic_ops_golang/
Date: Tue, 25 Feb 2020 07:27:33 GMT
Content-Length: 83
{
"alerts": [
{
"text": "notification was deleted.",
"level": "success"
}
]
}