federations/all

GET

Retrieves a list of Federation mappings (also called Federation Resolvers) for the current user.

Auth. Required:

Yes

Roles Required:

“admin”

Permissions Required:

FEDERATION-RESOLVER:READ, DELIVERY-SERVICE:READ

Response Type:

Array

Request Structure

No parameters available.

#828 Request Example
GET /api/4.0/federations/all HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...

Response Structure

deliveryService:

The xml_id of the delivery service.

mappings:

An array of objects that represent the mapping of a Federation’s CNAME to one or more Resolvers

cname:

The actual CNAME used by the Federation

ttl:

The TTL of the CNAME in hours

#829 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-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Sun, 23 Feb 2020 21:38:06 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: UQBlGVPJytYMkv0V42EAIoJUnXjBTCXnOGpOberxte6TtnX63LTAKFfD2LejBVYXkKtnCdkBbs+SzhA0H1zdog==
X-Server-Name: traffic_ops_golang/
Date: Sun, 23 Feb 2020 20:38:06 GMT
Content-Length: 138

{
    "response": [
        {
            "mappings": [
                {
                    "ttl": 60,
                    "cname": "img1.mcdn.ciab.test."
                },
                {
                    "ttl": 60,
                    "cname": "img2.mycdn.ciab.test."
                }
            ],
            "deliveryService": "demo1"
        },
        {
            "mappings": [
                {
                    "ttl": 60,
                    "cname": "static.mycdn.ciab.test."
                }
            ],
            "deliveryService": "demo2"
        }
    ]
}