OC/CI/configuration/{{host}}
PUT
Triggers an asynchronous task to update the configuration for the uCDN and the specified host by adding the request to a queue to be reviewed later. This returns a 202 Accepted status and an endpoint to be used for status updates.
Note
Users with the ICDN:UCDN-OVERRIDE
permission will need to provide a “ucdn” query parameter to bypass the need for uCDN information in the JWT and allow them to view all CDNi information.
- Auth. Required:
Yes
- Roles Required:
“admin” or “operations”
- Permissions Required:
CDNI:UPDATE
- Response Type:
Object
Request Structure
This requires authorization using a JWT provided by the dCDN to identify the uCDN. This token must include the following claims:
Name |
Description |
---|---|
iss |
Issuer claim as a string key for the uCDN |
aud |
Audience claim as a string key for the dCDN |
exp |
Expiration claim as the expiration date as a Unix epoch timestamp (in seconds) |
Name |
Description |
---|---|
host |
The text identifier for the host domain to be updated with the new configuration. |
- type:
A string of the type of metadata to follow. See RFC 8006 for possible values. Only a selection of these are supported.
- host-metadata:
An array of generic metadata objects that conform to RFC 8006.
- generic-metadata-type:
A string of the type of metadata to follow conforming to RFC 8006.
- generic-metadata-value:
An array of generic metadata value objects conforming to RFC 8006 and SVA specifications.
PUT /api/5.0/oc/ci/configuration/example.com HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 181
Content-Type: application/json
{
"type": "MI.HostMetadata",
"host-metadata": [
{
"generic-metadata-type": "MI.RequestedCapacityLimits",
"generic-metadata-value": {
"requested-limits": [
{
"limit-type": "egress",
"limit-value": 20000,
"footprints": [
{
"footprint-type": "ipv4cidr",
"footprint-value": [
"127.0.0.1",
"127.0.0.2"
]
}
]
}
]
}
}
]
}
Response Structure
HTTP/1.1 202 Accepted
Content-Type: application/json
{ "alerts": [
{
"text": "CDNi configuration update request received. Status updates can be found here: /api/5.0/async_status/1",
"level": "success"
}
]}