regions/{{ID}}

PUT

Updates a Region.

Auth. Required:

Yes

Role(s) Required:

“admin” or “operator”

Permissions Required:

REGION:UPDATE, REGION:READ

Response Type:

Object

Request Structure

Table 571 Request Path Parameters

Name

Description

ID

The integral, unique identifier of the :term:Region to update

division:

The new integral, unique identifier of the :term:Division which shall contain the :term:Region

name:

The new name of the :term:Region

#1417 Request Example
PUT /api/5.0/regions/5 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 60
Content-Type: application/json

{
    "division": 3,
    "name": "Leeds"
}

Response Structure

divisionName:

The name of the :term:Division which contains this :term:Region

division:

The integral, unique identifier of the :term:Division which contains this :term:Region

id:

An integral, unique identifier for this :term:Region

lastUpdated:

The date and time at which this :term:Region was last updated in RFC 3339 format

Changed in version 5.0: Prior to version 5.0 of the API, this field was in Traffic Ops’s Custom Date/Time Format.

name:

The :term:Region name

#1418 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: 7SVj4q7dtSTNQEJlBApEwlad28WBVFnpdHaatoIpNfeLltfcpcdVTcOKB4JXQv7rlSD2p/TxBQC6EXpxwYTnKQ==
X-Server-Name: traffic_ops_golang/
Date: Thu, 06 Dec 2018 02:23:40 GMT
Content-Length: 173

{ "alerts": [
    {
        "text": "region was updated.",
        "level": "success"
    }
],
"response": {
    "divisionName": "England",
    "division": 3,
    "id": 5,
    "lastUpdated": "2023-05-26T15:59:33.7096-06:00",
    "name": "Leeds"
}}