`parameters`

`GET`

Gets all Parameters configured in Traffic Ops

Auth. Required: Yes
Roles Required: None
Response Type: Array

Request Structure

Table 191 Request Query Parameters
Name	Required	Description
configFile	no	Filter Parameters by Config File
id	no	Filters Parameters by ID
name	no	Filter Parameters by Name
value	no	Filter Parameters by Value
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 n^th 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`.

New in version ATCv6: The value query parameter was added to all API versions in ATC version 6.0.

#419 Request Example

GET /api/3.0/parameters?configFile=records.config&name=location HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

configFile: The Parameter’s Config File
id: The Parameter’s ID
lastUpdated: The date and time at which this Parameter was last updated, in Traffic Ops’s Custom Date/Time Format
name: Name of the Parameter
profiles: An array of Profile Names that use this Parameter
secure: A boolean value that describes whether or not the Parameter is Secure
value: The Parameter’s Value

#420 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=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: UFO3/jcBFmFZM7CsrsIwTfPc5v8gUiXqJm6BNp1boPb4EQBnWNXZh/DbBwhMAOJoeqDImoDlrLnrVjQGO4AooA==
X-Server-Name: traffic_ops_golang/
Date: Wed, 05 Dec 2018 18:23:39 GMT
Content-Length: 212

{ "response": [
    {
        "configFile": "records.config",
        "id": 29,
        "lastUpdated": "2018-12-05 17:51:02+00",
        "name": "location",
        "profiles": [
            "ATS_EDGE_TIER_CACHE",
            "ATS_MID_TIER_CACHE"
        ],
        "secure": false,
        "value": "/etc/trafficserver/"
    }
]}

`POST`

Creates one or more new Parameters.

Auth. Required: Yes
Roles Required: “admin” or “operations”
Response Type: Array

Request Structure

The request body may be in one of two formats, a single Parameter object or an array of Parameter objects. Each Parameter object shall have the following keys:

configFile: The Parameter’s Config File
name: Name of the Parameter
secure: A boolean value that describes whether or not the Parameter is Secure
value: The Parameter’s Value

#421 Request Example - Single Object Format

POST /api/3.0/parameters HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 84
Content-Type: application/json

{
    "name": "test",
    "value": "quest",
    "configFile": "records.config",
    "secure": false
}

#422 Request Example - Array Format

POST /api/3.0/parameters HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 180
Content-Type: application/json

[{
    "name": "test",
    "value": "quest",
    "configFile": "records.config",
    "secure": false
},
{
    "name": "foo",
    "value": "bar",
    "configFile": "records.config",
    "secure": false
}]

Response Structure

configFile: The Parameter’s Config File
id: The Parameter’s ID
lastUpdated: The date and time at which this Parameter was last updated, in Traffic Ops’s Custom Date/Time Format
name: Name of the Parameter
profiles: An array of Profile Names that use this Parameter
secure: A boolean value that describes whether or not the Parameter is Secure
value: The Parameter’s Value

#423 Response Example - Single Object Format

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=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: eQrl48zWids0kDpfCYmmtYMpegjnFxfOVvlBYxxLSfp7P7p6oWX4uiC+/Cfh2X9i3G+MQ36eH95gukJqOBOGbQ==
X-Server-Name: traffic_ops_golang/
Date: Wed, 05 Dec 2018 19:18:21 GMT
Content-Length: 212

{ "alerts": [
    {
        "text": "param was created.",
        "level": "success"
    }
],
"response": {
    "configFile": "records.config",
    "id": 124,
    "lastUpdated": "2018-12-05 19:18:21+00",
    "name": "test",
    "profiles": null,
    "secure": false,
    "value": "quest"
}}

parameters

GET

Request Structure

Response Structure

POST

Request Structure

Response Structure

`parameters`

`GET`

`POST`