steering

GET

Gets a list of all Steering Targets in the Traffic Ops database.

Auth. Required:

Yes

Roles Required:

“Portal”, “Steering”, “Federation”, “operations” or “admin”

Permissions Required:

STEERING:READ, DELIVERY-SERVICE:READ

Response Type:

Array

Request Structure

No parameters available.

#1038 Request Example

GET /api/4.0/steering HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...

Response Structure

deliveryService:

A string that is the xml_id of the steering Delivery Service

clientSteering:

Whether this is a client steering Delivery Service.

targets:

The delivery services that the Steering Delivery Service targets.

order:

If this is a STEERING_ORDER target, this is the value of the order. Otherwise, 0.

weight:

If this is a STEERING_WEIGHT target, this is the value of the weight. Otherwise, 0.

deliveryService:

A string that is the xml_id of the steering Delivery Service

filters:

Filters of type STEERING_REGEXP that exist on either of the targets.

deliveryService:

A string that is the xml_id of the steering Delivery Service

pattern:

A regular expression - the use of this pattern is dependent on the type field (backslashes are escaped)

#1039 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=Mon, 24 Feb 2020 18:56:57 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: hcJa4xVLDx7bxBmoSjYo5YUwdSBWQr9GlqRYrc6ZU7LeenjiV3go22YlIHt/GtjLcHQjJ5DulKRhdsvFMq7Fng==
X-Server-Name: traffic_ops_golang/
Date: Mon, 24 Feb 2020 17:56:57 GMT
Content-Length: 167

{
    "response": [
        {
            "deliveryService": "steering1",
            "clientSteering": true,
            "targets": [
                {
                    "order": 0,
                    "weight": 1,
                    "deliveryService": "demo1"
                },
                {
                    "order": 0,
                    "weight": 2,
                    "deliveryService": "demo2"
                }
            ],
            "filters": [
                {
                    "deliveryService": "demo1",
                    "pattern": ".*\\.demo1\\..*"
                },
                {
                    "deliveryService": "demo2",
                    "pattern": ".*\\.demo2*\\..*"
                }
            ]
        }
    ]
}