cachegroupparameters

Deprecated since version ATCv6.

GET

Extract information about the Parameters associated with Cache Groups.

Auth. Required

Yes

Roles Required

None

Response Type

Object

Response Structure

Table 102 Request Query Parameters

Name

Required

Description

cachegroup

no

Show only the Parameters with the Cache Group identified by this integral, unique identifier

parameter

no

Show only the Parameters with the Parameter identified by this integral, unique identifier

orderby

no

Choose the ordering of the results - must be the name of one of the fields of the objects in the response array

sortOrder

no

Changes the order of sorting. Either ascending (default or “asc”) or descending (“desc”)

limit

no

Choose the maximum number of results to return

offset

no

The number of results to skip before beginning to return results. Must use in conjunction with limit

page

no

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.

Response Structure

cachegroupParameters

An array of identifying information for the Parameters of Cache Groups

cachegroup

A string containing the Name of the Cache Group

last_updated

Date and time of last modification in Traffic Ops’s Custom Date/Time Format

parameter

An integer that is the Parameter’s ID

#206 Response Example
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Type: application/json
Date: Wed, 14 Nov 2018 18:24:12 GMT
X-Server-Name: traffic_ops_golang/
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Vary: Accept-Encoding
Whole-Content-Sha512: PZyh09NeYYy4sXSv+Bfov0v32EuEk/1y7/B+4fyvhbcPxWQ650NXBDpAe8IsmYZQYVRB03xlBtc33bo3Ixunbg==
Content-Length: 124

{ "response": {
    "cachegroupParameters": [
        {
            "parameter": 124,
            "last_updated": "2018-11-14 18:23:40.488853+00",
            "cachegroup": "test"
        }
    ]
}}

Deprecated since version ATCv6.

POST

Assign Parameter(s) to Cache Group(s).

Auth. Required

Yes

Roles Required

“admin” or “operations”

Response Type

Array

Request Structure

This endpoint accepts two formats for the request payload:

Single Object Format

For assigning a single Parameter to a single Cache Group

Array Format

For making multiple assignments of Parameters to Cache Groups simultaneously

Single Object Format

cacheGroupId

An integer that is the ID of the Cache Group to which a Parameter is being assigned

parameterId

An integer that is the ID of the Parameter being assigned

#207 Request Example
POST /api/3.0/cachegroupparameters HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 39
Content-Type: application/json

{
    "cacheGroupId": 8,
    "parameterId": 124
}

Array Format

cacheGroupId

An integer that is the ID of the Cache Group to which a Parameter is being assigned

parameterId

An integer that is the ID of the Parameter being assigned

#208 Request Example
POST /api/3.0/cachegroupparameters HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 39
Content-Type: application/json

[{
    "cacheGroupId": 8,
    "parameterId": 124
},
{
    "cacheGroupId": 8,
    "parameterId": 125
}]

Response Structure

cacheGroupId

An integer that is the ID of the Cache Group to which a Parameter has been assigned

parameterId

An integer that is the ID of the Parameter which has been assigned

#209 Response Example
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Type: application/json
Date: Wed, 14 Nov 2018 15:47:49 GMT
X-Server-Name: traffic_ops_golang/
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Vary: Accept-Encoding
Whole-Content-Sha512: wCv388wFaSjgFLCnI9dchlcyGxaVr8IhBAG25F+rpI2/azCswEYTcVBSlYOg6NxTQRzGkluMvn67jI6rV+vNsQ==
Content-Length: 136

{ "alerts": [
    {
        "level": "success",
        "text": "Cachegroup parameter associations were created."
    }
],
"response": [
    {
        "cacheGroupId": 8,
        "parameterId": 124
    }
]}