profiles/{{ID}}

PUT

Replaces the specified Profile with the one in the request payload

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

PROFILE:UPDATE, PROFILE:READ

Response Type:

Object

Request Structure

Table 381 Request Path Parameters

Name

Description

ID

The ID of the Profile being modified

cdn:

The integral, unique identifier of the CDN to which this Profile will belong

description:

The Profile’s new Description

name:

The Profile’s new Name

routingDisabled:

The Profile’s new Routing Disabled setting

type:

The Profile’s new Type

Warning

Changing this will likely break something, be VERY careful when modifying this value

#921 Request Example
PUT /api/4.0/profiles/16 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.62.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 125
Content-Type: application/json

{
    "name": "test",
    "description": "A test profile for API examples",
    "cdn": 2,
    "type": "UNK_PROFILE",
    "routingDisabled": true
}

Response Structure

cdn:

The integral, unique identifier of the CDN to which this Profile belongs

cdnName:

The name of the CDN to which this Profile belongs

description:

The Profile’s Description

id:

The Profile’s ID

lastUpdated:

The date and time at which this Profile was last updated, in Traffic Ops’s Custom Date/Time Format

name:

The Profile’s Name

routingDisabled:

The Profile’s Routing Disabled setting

type:

The Profile’s Type

#922 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: Pnf+G9G3/+edt4b8PVsyGZHsNzaFEgphaGSminjRlRmMpWtuLAA20WZDUo3nX0QO81c2GCuFuEh9uMF2Vjeppg==
X-Server-Name: traffic_ops_golang/
Date: Fri, 07 Dec 2018 21:45:06 GMT
Content-Length: 251

{ "alerts": [
    {
        "text": "profile was updated.",
        "level": "success"
    }
],
"response": {
    "id": 16,
    "lastUpdated": "2018-12-07 21:45:06+00",
    "name": "test",
    "description": "A test profile for API examples",
    "cdnName": null,
    "cdn": 2,
    "routingDisabled": true,
    "type": "UNK_PROFILE"
}}

DELETE

Allows user to delete a Profile.

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

PROFILE:DELETE, PROFILE:READ

Response Type:

undefined

Request Structure

Table 382 Request Path Parameters

Name

Description

ID

The ID of the Profile being deleted

#923 Request Example
DELETE /api/4.0/profiles/16 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.62.0
Accept: */*
Cookie: mojolicious=...

Response Structure

#924 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: HNmJkZaNW9yil08/3TnqZ5FllH6Rp+jgp3KI46FZdojLYcu+8jEhDLl1okoirdrHyU4R1c3hjCI0urN7PVvWDA==
X-Server-Name: traffic_ops_golang/
Date: Fri, 07 Dec 2018 21:55:33 GMT
Content-Length: 62

{ "alerts": [
    {
        "text": "profile was deleted.",
        "level": "success"
    }
]}