Skip to content

Latest commit

 

History

History
194 lines (162 loc) · 8.1 KB

cdns_name_federations.rst

File metadata and controls

194 lines (162 loc) · 8.1 KB
Raw

cdns/{{name}}/federations

GET

Retrieves a list of federations in use by a specific CDN.

Auth. Required:Yes
Roles Required:None
Permissions Required:CDN:READ, FEDERATION:READ, DELIVERY-SERVICE:READ
Response Type:Array

Request Structure

Request Path Parameters
Name Description
name The name of the CDN for which federations will be listed
Request Query Parameters
Name Description
id Return only the :term:`Federation` that has this ID
cname Return only those :term:`Federations` that have this CNAME
orderby Choose the ordering of the results - must be the name of one of the fields of the objects in the response array
sortOrder Changes the order of sorting. Either ascending (default or "asc") or descending ("desc")
limit Choose the maximum number of results to return
offset The number of results to skip before beginning to return results. Must use in conjunction with limit
page Return the nth page of results, where "n" is the value of this parameter, pages are limit long and the first page is 1. If offset was defined, this query parameter has no effect. limit must be defined to make use of page. 
GET /api/4.0/cdns/CDN-in-a-Box/federations HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.62.0
Accept: */*
Cookie: mojolicious=...

Response Structure

cname:

The Canonical Name (CNAME) used by the federation
deliveryService:

An object with keys that provide identifying information for the :term:`Delivery Service` using this federation

id:The integral, unique identifier for the :term:`Delivery Service`
xmlId:The :term:`Delivery Service`'s uniquely identifying 'xml_id'
description:

A human-readable description of the :term:`Federation`. This can be null as well as an empty string.
lastUpdated:

The date and time at which this federation was last modified, in :ref:`non-rfc-datetime`
ttl:

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

 
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: SJA7G+7G5KcOfCtnE3Dq5DCobWtGRUKSppiDkfLZoG5+paq4E1aZGqUb6vGVsd+TpPg75MLlhyqfdfCHnhLX/g==
x-server-name: traffic_ops_golang/
content-length: 170
date: Wed, 05 Dec 2018 00:35:40 GMT

{ "response": [
        {
                "id": 1,
                "cname": "test.quest.",
                "ttl": 48,
                "description": "A test federation",
                "lastUpdated": "2018-12-05 00:05:16+00",
                "deliveryService": {
                        "id": 1,
                        "xmlId": "demo1"
                }
        }
]}

POST

Creates a new federation.

Auth. Required:Yes
Roles Required:"admin"
Permissions Required:FEDERATION:CREATE, FEDERATION:READ, CDN:READ
Response Type:Object

Request Structure

Request Path Parameters
Name Description
name The name of the CDN for which a new federation will be created
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

 
POST /api/4.0/cdns/CDN-in-a-Box/federations HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.62.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 72
Content-Type: application/json

{
        "cname": "test.quest.",
        "ttl": 48,
        "description": "A test federation"
}

Response Structure

id:The intergral, unique identifier of the :term:`Federation`
cname:The Canonical Name (CNAME) used by the federation
description:The description of the :term:`Federation`
lastUpdated:The date and time at which this federation was last modified, in :ref:`non-rfc-datetime`
ttl:Time to Live (TTL) for the cname, in hours 
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: rRsWAIhXzVlj8Hy+8aFjp4Jo1QGTK49m0N1AP5QDyyAZ1TfNIdgtcgiuehu7FiN1IPWRFiv6D9CygFYKGcVDOw==
x-server-name: traffic_ops_golang/
content-length: 192
date: Wed, 05 Dec 2018 00:05:16 GMT

{ "alerts": [
        {
                "text": "cdnfederation was created.",
                "level": "success"
        }
],
"response": {
        "id": 1,
        "cname": "test.quest.",
        "ttl": 48,
        "description": "A test federation",
        "lastUpdated": "2018-12-05 00:05:16+00"
}}