server_capabilities

GET

Retrieves Server Capabilities.

Auth. Required:

Yes

Roles Required:

“read-only”

Permissions Required:

SERVER-CAPABILITY:READ

Response Type:

Array

Request Structure

Table 575 Request Query Parameters

Name	Required	Description
name	no	Return the Server Capability with this name

#1427 Request Structure

GET /api/5.0/server_capabilities?name=RAM HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

name:

The name of this Server Capability

description:

The description of this Server Capability

lastUpdated:

The date and time at which this Server Capability 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.

#1428 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: EH8jo8OrCu79Tz9xpgT3YRyKJ/p2NcTmbS3huwtqRByHz9H6qZLQjA59RIPaVSq3ZxsU6QhTaox5nBkQ9LPSAA==
X-Server-Name: traffic_ops_golang/
Date: Wed, 03 May 2023 07:03:45 GMT
Content-Length: 68

{
    "response": [
        {
            "name": "RAM",
            "description": "ram server capability",
            "lastUpdated": "2023-05-03T12:24:40.409579+05:30"
        }
    ]
}

POST

Create a new Server Capability.

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

SERVER-CAPABILITY:CREATE, SERVER-CAPABILITY:READ

Response Type:

Object

Request Structure

name:

The name of the Server Capability

description:

The description of this Server Capability

#1429 Request Example

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

{
    "name": "RAM",
    "description": "ram server capability",
}

Response Structure

name:

The name of this Server Capability

description:

The description of this Server Capability

lastUpdated:

The date and time at which this Server Capability 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.

#1430 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: ysdopC//JQI79BRUa61s6M2HzHxYHpo5RdcuauOoqCYxiVOoUhNZfOVydVkv8zDN2qA374XKnym4kWj3VzQIXg==
X-Server-Name: traffic_ops_golang/
Date: Wed, 03 May 2023 07:02:02 GMT
Content-Length: 137

{
    "alerts": [
        {
            "text": "server capability was created.",
            "level": "success"
        }
    ],
    "response": {
        "name": "RAM",
        "description": "ram server capability",
        "lastUpdated": "2023-05-03T12:24:40.409579+05:30"
    }
}

PUT

Update an existing Server Capability.

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

SERVER-CAPABILITY:UPDATE, SERVER-CAPABILITY:READ

Response Type:

Object

Request Structure

name:

The name of the Server Capability

description:

The description of this Server Capability

#1431 Request Example

PUT /api/5.0/server_capabilities?name=RAM HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 15
Content-Type: application/json

{
    "name": "HDD",
    "description": "HDD server capability"
}

Response Structure

name:

The name of this Server Capability

description:

The description of this Server Capability

lastUpdated:

The date and time at which this Server Capability 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.

#1432 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: ysdopC//JQI79BRUa61s6M2HzHxYHpo5RdcuauOoqCYxiVOoUhNZfOVydVkv8zDN2qA374XKnym4kWj3VzQIXg==
X-Server-Name: traffic_ops_golang/
Date: Wed, 03 May 2023 07:02:02 GMT
Content-Length: 137

{
    "alerts": [
        {
            "text": "server capability was updated.",
            "level": "success"
        }
    ],
    "response": {
        "name": "HDD",
        "description": "HDD server capability",
        "lastUpdated": "2023-05-03T12:24:40.409579+05:30"
    }
}

DELETE

Deletes a specific Server Capability.

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

SERVER-CAPABILITY:DELETE, SERVER-CAPABILITY:READ

Response Type:

undefined

Request Structure

Table 576 Request Query Parameters

Name	Required	Description
name	yes	The name of the Server Capability to be deleted

#1433 Request Example

DELETE /api/5.0/server_capabilities?name=RAM HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

#1434 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: 8zCAATbCzcqiqigGVBy7WF1duDuXu1Wg2DBe9yfqTw/c+yhE2eUk73hFTA/Oqt0kocaN7+1GkbFdPkQPvbnRaA==
X-Server-Name: traffic_ops_golang/
Date: Wed, 03 May 2023 07:02:02 GMT
Content-Length: 72

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