cdns/{{name}}/federations/{{ID}}

PUT

Updates a federation.

Auth. Required

Yes

Roles Required

“admin”

Permissions Required

FEDERATION:UPDATE, FEDERATION:READ, CDN:READ

Response Type

Object

Request Structure

Table 286 Request Path Parameters

Name

Description

name

The name of the CDN for which the federation identified by ID will be inspected

ID

An integral, unique identifier for the federation to be inspected

cname

The Canonical Name (CNAME) used by the federation

Note

The CNAME must end with a “.

description

An optional description of the federation

ttl

Time to Live (TTL) for the name record used for cname

#688 Request Example
PUT /api/4.0/cdns/CDN-in-a-Box/federations/1 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.62.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 33
Content-Type: application/json

{
    "cname": "foo.bar.",
    "ttl": 48
}

Response Structure

cname

The Canonical Name (CNAME) used by the federation

description

An optionally-present field containing a description of the field

Note

This key will only be present if the description was provided when the federation was created

lastUpdated

The date and time at which this federation was last modified, in Traffic Ops’s Custom Date/Time Format

ttl

Time to Live (TTL) for the cname, in hours

#689 Response Example
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-type: application/json
set-cookie: mojolicious=...; Path=/; HttpOnly
whole-content-sha512: qcjfQ+gDjNxYQ1aq+dlddgrkFWnkFYxsFF+SHDqqH0uVHBVksmU0aTFgltozek/u6wbrGoR1LFf9Fr1C1SbigA==
x-server-name: traffic_ops_golang/
content-length: 174
date: Wed, 05 Dec 2018 01:03:40 GMT

{ "alerts": [
    {
        "text": "cdnfederation was updated.",
        "level": "success"
    }
],
"response": {
    "id": 1,
    "cname": "foo.bar.",
    "ttl": 48,
    "description": null,
    "lastUpdated": "2018-12-05 01:03:40+00"
}}

DELETE

Deletes a specific federation.

Auth. Required

Yes

Roles Required

“admin”

Permissions Required

FEDERATION:DELETE, FEDERATION:READ, CDN:READ

Response Type

undefined

Request Structure

Table 287 Request Path Parameters

Name

Description

name

The name of the CDN for which the federation identified by ID will be inspected

ID

An integral, unique identifier for the federation to be inspected

#690 Request Example
DELETE /api/4.0/cdns/CDN-in-a-Box/federations/1 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.62.0
Accept: */*
Cookie: mojolicious=...

Response Structure

#691 Response Example
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-type: application/json
set-cookie: mojolicious=...; Path=/; HttpOnly
whole-content-sha512: Cnkfj6dmzTD3if9oiDq33tqf7CnAflKK/SPgqJyfu6HUfOjLJOgKIZvkcs2wWY6EjLVdw5qsatsd4FPoCyjvcw==
x-server-name: traffic_ops_golang/
content-length: 68
date: Wed, 05 Dec 2018 01:17:24 GMT

{ "alerts": [
    {
        "text": "cdnfederation was deleted.",
        "level": "success"
    }
]}