TO Extensions¶
GET /api/1.1/to_extensions.json
Retrieves the list of extensions.
Authentication Required: Yes
Response Content Type: application/json
Return Values
Parameter | Type | Description |
---|---|---|
script_file |
string | |
version |
string | |
name |
string | |
description |
string | |
info_url |
string | |
additional_config_json |
string | |
isactive |
string | |
id |
string | |
type |
string | |
servercheck_short_name |
string |
Response Example
{
“response”: [
{
script_file: "ping",
version: "1.0.0",
name: "ILO_PING",
description: null,
info_url: "http://foo.com/bar.html",
additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
isactive: "1",
id: "1",
type: "CHECK_EXTENSION_BOOL",
servercheck_short_name: "ILO"
},
{
script_file: "ping",
version: "1.0.0",
name: "10G_PING",
description: null,
info_url: "http://foo.com/bar.html",
additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
isactive: "1",
id: "2",
type: "CHECK_EXTENSION_BOOL",
servercheck_short_name: "10G"
}
],
“version”: "1.1"
}
POST /api/1.1/to_extensions
Creates a Traffic Ops extension.
Authentication Required: Yes
Request Parameters
Parameter Type Description name
string version
string info_url
string script_file
string isactive
string additional_config_json
string description
string servercheck_short_name
string type
string Request Example
{ "name": "ILO_PING", "version": "1.0.0", "info_url": "http://foo.com/bar.html", "script_file": "ping", "isactive": "1", "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}", "description": null, "servercheck_short_name": "ILO" "type": "CHECK_EXTENSION_BOOL", }Response Content Type: application/json
Response Properties
Parameter Type Description alerts
array A collection of alert messages. >level
string Success, info, warning or error. >text
string Alert message. Response Example
{ "alerts": [ { "level": "success", "text": "Check Extension loaded." } ], "version": "1.1" }
POST /api/1.1/to_extensions/:id/delete
Deletes a Traffic Ops extension.
Authentication Required: Yes
Request Route Parameters
Name Required Description id
yes TO extension id Response Content Type: application/json
Response Properties
Parameter Type Description alerts
array A collection of alert messages. >level
string Success, info, warning or error. >text
string Alert message. Response Example
{ "alerts": [ { "level": "success", "text": "Extension deleted." } ], "version": "1.1" }