profiles
GET
- Auth. Required:
Yes
- Roles Required:
None
- Permissions Required:
PROFILE:READ
- Response Type:
Array
Request Structure
Name |
Required |
Description |
---|---|---|
cdn |
no |
Used to filter Profiles by the integral, unique identifier of the CDN to which they belong |
id |
no |
|
name |
no |
|
param |
no |
Used to filter Profiles by the ID of a Parameter associated with them |
GET /api/5.0/profiles?name=ATS_EDGE_TIER_CACHE HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.62.0
Accept: */*
Cookie: mojolicious=...
Response Structure
- cdn:
The integral, unique identifier of the CDN to which this Profile belongs
- cdnName:
- description:
The Profile’s Description
- id:
- lastUpdated:
The date and time at which this Profile 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:
- routingDisabled:
The Profile’s Routing Disabled setting
- type:
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: QEpKM/DwHBRvue9K7XKrpwKFKhW6yCMQ2vSQgxE7dWFGJaqC4KOUO92bsJU/5fjI9qlB+1uMT2kz6mFb1Wzp/w==
X-Server-Name: traffic_ops_golang/
Date: Fri, 07 Dec 2018 20:40:31 GMT
Content-Length: 220
{ "response": [
{
"id": 9,
"lastUpdated": "2023-08-17T09:06:18-06:00",
"name": "ATS_EDGE_TIER_CACHE",
"description": "Edge Cache - Apache Traffic Server",
"cdnName": "CDN-in-a-Box",
"cdn": 2,
"routingDisabled": false,
"type": "ATS_PROFILE"
}
]}
POST
Creates a new Profile.
- Auth. Required:
Yes
- Roles Required:
“admin” or “operations”
- Permissions Required:
PROFILE:CREATE, PROFILE:READ
- Response Type:
Object
Request Structure
- cdn:
The integral, unique identifier of the CDN to which this Profile shall belong
- description:
The Profile’s Description
- name:
- routingDisabled:
The Profile’s Routing Disabled setting
- type:
POST /api/5.0/profiles 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:
- description:
The Profile’s Description
- id:
- lastUpdated:
The date and time at which this Profile 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:
- routingDisabled:
The Profile’s Routing Disabled setting
- type:
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: UGV3PCnYBY0J3siICR0f9VVRNdUK1+9zsDDP6T9yt6t+AoHckHe6bvzOli9to/fGhC2zz5l9Nc1ro4taJUDD8g==
X-Server-Name: traffic_ops_golang/
Date: Fri, 07 Dec 2018 21:24:49 GMT
Content-Length: 251
{ "alerts": [
{
"text": "profile was created.",
"level": "success"
}
],
"response": {
"id": 16,
"lastUpdated": "2023-08-17T09:06:18-06:00",
"name": "test",
"description": "A test profile for API examples",
"cdnName": null,
"cdn": 2,
"routingDisabled": true,
"type": "UNK_PROFILE"
}}