servers
GET
Retrieves properties of all servers across all CDNs.
- Auth. Required
Yes
- Roles Required
None
- Permissions Required
SERVER:READ, DELIVERY-SERVICE:READ, CDN:READ, PHYSICAL-LOCATION:READ, CACHE-GROUP:READ, TYPE:READ, PROFILE:READ
- Response Type
Array
Request Structure
Name |
Required |
Description |
---|---|---|
cachegroup |
no |
Return only those servers within the Cache Group that has this ID |
cachegroupName |
no |
Return only those servers within the Cache Group that has this Name |
dsId |
no |
Return only those servers assigned to the Delivery Service identified by this integral, unique identifier. If the Delivery Service has a Topology assigned to it, the servers endpoint will return each server whose Cache Group is associated with a Topology Node of that Topology and has the Server Capabilities that are required by the Delivery Service but excluding Origin Servers that are not assigned to the Delivery Service. For more information, see Configure Multi-Site Origin. |
hostName |
no |
Return only those servers that have this (short) hostname |
id |
no |
Return only the server with this integral, unique identifier |
profileName |
no |
Return only those servers that are using the Profile that has this Name |
status |
no |
Return only those servers with this status - see Health Protocol |
type |
no |
Return only servers of this Type |
topology |
no |
Return only servers who belong to cachegroups assigned to the Topology identified by this name |
sortOrder |
no |
Changes the order of sorting. Either ascending (default or “asc”) or descending (“desc”) |
limit |
no |
Choose the maximum number of results to return |
offset |
no |
The number of results to skip before beginning to return results. Must use in conjunction with limit |
page |
no |
Return the nth page of results, where “n” is the value of this parameter, pages are |
GET /api/4.0/servers?hostName=mid HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Response Structure
- cachegroup
A string that is the name of the Cache Group to which the server belongs
- cachegroupId
An integer that is the ID of the Cache Group to which the server belongs
- cdnId
The integral, unique identifier of the CDN to which the server belongs
- cdnName
Name of the CDN to which the server belongs
- configUpdateTime
The last time an update was requested for this server. This field defaults to standard epoch
- configApplyTime
The last time an update was applied for this server. This field defaults to standard epoch
- domainName
The domain part of the server’s FQDN
- guid
An identifier used to uniquely identify the server
Note
This is a legacy key which only still exists for compatibility reasons - it should always be
null
- hostName
The (short) hostname of the server
- httpsPort
The port on which the server listens for incoming HTTPS connections/requests
- id
An integral, unique identifier for this server
- iloIpAddress
The IPv4 address of the server’s ILO service1
- iloIpGateway
The IPv4 gateway address of the server’s ILO service1
- iloIpNetmask
The IPv4 subnet mask of the server’s ILO service1
- iloPassword
The password of the of the server’s ILO service user1 - displays as simply
******
if the currently logged-in user does not have the ‘admin’ or ‘operations’ Role(s)- iloUsername
The user name for the server’s ILO service1
- interfaces
A set of the network interfaces in use by the server. In most scenarios, only one will be present, but it is illegal for this set to be an empty collection.
- ipAddresses
A set of objects representing IP Addresses assigned to this network interface. In most scenarios, only one or two (usually one IPv4 address and one IPv6 address) will be present, but it is illegal for this set to be an empty collection.
- address
The actual IP address, including any mask as a CIDR-notation suffix
- gateway
Either the IP address of the network gateway for this address, or
null
to signify that no such gateway exists- serviceAddress
A boolean that describes whether or not the server’s main service is available at this IP address. When this property is
true
, the IP address is referred to as a “service address”. It is illegal for a server to not have at least one service address. It is also illegal for a server to have more than one service address of the same address family (i.e. more than one IPv4 service address and/or more than one IPv6 address). Finally, all service addresses for a server must be contained within one interface - which is therefore sometimes referred to as the “service interface” for the server.
- maxBandwidth
The maximum healthy bandwidth allowed for this interface. If bandwidth exceeds this limit, Traffic Monitors will consider the entire server unhealthy - which includes all configured network interfaces. If this is
null
, it has the meaning “no limit”. It has no effect ifmonitor
is not true for this interface.See also
- monitor
A boolean which describes whether or not this interface should be monitored by Traffic Monitor for statistics and health consideration.
- mtu
The MTU of this interface. If it is
null
, it may be assumed that the information is either not available or not applicable for this interface.- name
The name of the interface. No two interfaces of the same server may share a name. It is the same as the network interface’s device name on the server, e.g.
eth0
.- routerPortName
The human-readable name of the router responsible for reaching this server’s interface.
- routerPortName
The human-readable name of the port used by the router responsible for reaching this server’s interface.
- lastUpdated
The date and time at which this server description was last modified
- mgmtIpAddress
The IPv4 address of some network interface on the server used for ‘management’
Deprecated since version 3.0: This field is deprecated and will be removed in a future API version. Operators should migrate this data into the
interfaces
property of the server.- mgmtIpGateway
The IPv4 address of a gateway used by some network interface on the server used for ‘management’
Deprecated since version 3.0: This field is deprecated and will be removed in a future API version. Operators should migrate this data into the
interfaces
property of the server.- mgmtIpNetmask
The IPv4 subnet mask used by some network interface on the server used for ‘management’
Deprecated since version 3.0: This field is deprecated and will be removed in a future API version. Operators should migrate this data into the
interfaces
property of the server.- offlineReason
A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status
- physLocation
The name of the physical location where the server resides
- physLocationId
An integral, unique identifier for the physical location where the server resides
- profileNames
- revalPending
A boolean value which, if
true
indicates that this server has pending content invalidation/revalidation- revalUpdateTime
The last time a content invalidation/revalidation request was submitted for this server. This field defaults to standard epoch
- revalApplyTime
The last time a content invalidation/revalidation request was applied by this server. This field defaults to standard epoch
- rack
A string indicating “server rack” location
- status
The Status of the server
See also
- statusId
The integral, unique identifier of the status of this server
See also
- tcpPort
The port on which this server listens for incoming TCP connections
Note
This is typically thought of as synonymous with “HTTP port”, as the port specified by
httpsPort
may also be used for incoming TCP connections.- type
The name of the Type of this server
- typeId
The integral, unique identifier of the ‘type’ of this server
- updPending
A boolean value which, if
true
, indicates that the server has updates of some kind pending, typically to be acted upon by Traffic Control Cache Config (t3c, formerly ORT)- xmppId
A system-generated UUID used to generate a server hashId for use in Traffic Router’s consistent hashing algorithm. This value is set when a server is created and cannot be changed afterwards.
- xmppPasswd
The password used in XMPP communications with the server
HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Tue, 19 May 2020 17:06:25 GMT; Max-Age=3600; HttpOnly
Vary: Accept-Encoding
X-Server-Name: traffic_ops_golang/
Date: Tue, 19 May 2020 16:06:25 GMT
Content-Length: 538
{ "response": [{
"cachegroup": "CDN_in_a_Box_Mid",
"cachegroupId": 6,
"cdnId": 2,
"cdnName": "CDN-in-a-Box",
"configUpdateTime": "1969-12-31T17:00:00-07:00",
"configApplyTime": "1969-12-31T17:00:00-07:00",
"domainName": "infra.ciab.test",
"guid": null,
"hostName": "mid",
"httpsPort": 443,
"id": 12,
"iloIpAddress": "",
"iloIpGateway": "",
"iloIpNetmask": "",
"iloPassword": "",
"iloUsername": "",
"lastUpdated": "2020-05-19 14:49:39+00",
"mgmtIpAddress": "",
"mgmtIpGateway": "",
"mgmtIpNetmask": "",
"offlineReason": "",
"physLocation": "Apachecon North America 2018",
"physLocationId": 1,
"profileNames": ["ATS_MID_TIER_CACHE"],
"rack": "",
"revalPending": false,
"revalUpdateTime": "1969-12-31T17:00:00-07:00",
"revalApplyTime": "1969-12-31T17:00:00-07:00",
"status": "REPORTED",
"statusId": 3,
"tcpPort": 80,
"type": "MID",
"typeId": 12,
"updPending": false,
"xmppId": "",
"xmppPasswd": "",
"interfaces": [
{
"ipAddresses": [
{
"address": "172.26.0.4/16",
"gateway": "172.26.0.1",
"serviceAddress": true
}
],
"maxBandwidth": null,
"monitor": false,
"mtu": 1500,
"name": "eth0",
"routerHostName": "",
"routerPortName": ""
}
]
}],
"summary": {
"count": 13
}}
Summary Fields
The summary
object returned by this method of this endpoint uses only the count
standard property.
POST
Allows a user to create a new server.
- Auth. Required
Yes
- Roles Required
“admin” or “operations”
- Permissions Required
SERVER:CREATE, SERVER:READ, DELIVERY-SERVICE:READ, CDN:READ, PHYSICAL-LOCATION:READ, CACHE-GROUP:READ, TYPE:READ, PROFILE:READ
- Response Type
Object
Request Structure
- cachegroupId
An integer that is the ID of the Cache Group to which the server shall belong
- cdnId
The integral, unique identifier of the CDN to which the server shall belong
- domainName
The domain part of the server’s FQDN
- hostName
The (short) hostname of the server
- httpsPort
An optional port number on which the server listens for incoming HTTPS connections/requests
- iloIpAddress
An optional IPv4 address of the server’s ILO service1
- iloIpGateway
An optional IPv4 gateway address of the server’s ILO service1
- iloIpNetmask
An optional IPv4 subnet mask of the server’s ILO service1
- iloPassword
An optional string containing the password of the of the server’s ILO service user1 - displays as simply
******
if the currently logged-in user does not have the ‘admin’ or ‘operations’ Role(s)- iloUsername
An optional string containing the user name for the server’s ILO service1
- interfaces
A set of the network interfaces in use by the server. In most scenarios, only one will be necessary, but it is illegal for this set to be an empty collection.
- ipAddresses
A set of objects representing IP Addresses assigned to this network interface. In most scenarios, only one or two (usually one IPv4 address and one IPv6 address) will be necessary, but it is illegal for this set to be an empty collection.
- address
The actual IP address, including any mask as a CIDR-notation suffix
- gateway
Either the IP address of the network gateway for this address, or
null
to signify that no such gateway exists- serviceAddress
A boolean that describes whether or not the server’s main service is available at this IP address. When this property is
true
, the IP address is referred to as a “service address”. It is illegal for a server to not have at least one service address. It is also illegal for a server to have more than one service address of the same address family (i.e. more than one IPv4 service address and/or more than one IPv6 address). Finally, all service addresses for a server must be contained within one interface - which is therefore sometimes referred to as the “service interface” for the server.
- maxBandwidth
The maximum healthy bandwidth allowed for this interface. If bandwidth exceeds this limit, Traffic Monitors will consider the entire server unhealthy - which includes all configured network interfaces. If this is
null
, it has the meaning “no limit”. It has no effect ifmonitor
is not true for this interface.See also
- monitor
A boolean which describes whether or not this interface should be monitored by Traffic Monitor for statistics and health consideration.
- mtu
The MTU of this interface. If it is
null
, it may be assumed that the information is either not available or not applicable for this interface.- name
The name of the interface. No two interfaces of the same server may share a name. It is the same as the network interface’s device name on the server, e.g.
eth0
.- routerPortName
The human-readable name of the router responsible for reaching this server’s interface.
- routerPortName
The human-readable name of the port used by the router responsible for reaching this server’s interface.
- mgmtIpAddress
The IPv4 address of some network interface on the server used for ‘management’
Deprecated since version 3.0: This field is deprecated and will be removed in a future API version. Operators should migrate this data into the
interfaces
property of the server.- mgmtIpGateway
The IPv4 address of a gateway used by some network interface on the server used for ‘management’
Deprecated since version 3.0: This field is deprecated and will be removed in a future API version. Operators should migrate this data into the
interfaces
property of the server.- mgmtIpNetmask
The IPv4 subnet mask used by some network interface on the server used for ‘management’
Deprecated since version 3.0: This field is deprecated and will be removed in a future API version. Operators should migrate this data into the
interfaces
property of the server.- physLocationId
An integral, unique identifier for the physical location where the server resides
- profileNames
List of Name of the Profiles that shall be used by this server
- rack
An optional string indicating “server rack” location
- statusId
The integral, unique identifier of the status of this server
See also
- tcpPort
An optional port number on which this server listens for incoming TCP connections
Note
This is typically thought of as synonymous with “HTTP port”, as the port specified by
httpsPort
may also be used for incoming TCP connections.- typeId
The integral, unique identifier of the ‘type’ of this server
- xmppId
A system-generated UUID used to generate a server hashId for use in Traffic Router’s consistent hashing algorithm. This value is set when a server is created and cannot be changed afterwards.
- xmppPasswd
An optional password used in XMPP communications with the server
POST /api/4.0/servers HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 599
Content-Type: application/json
{
"cachegroupId": 6,
"cdnId": 2,
"domainName": "infra.ciab.test",
"hostName": "test",
"httpsPort": 443,
"iloIpAddress": "",
"iloIpGateway": "",
"iloIpNetmask": "",
"iloPassword": "",
"iloUsername": "",
"interfaces": [
{
"ipAddresses": [
{
"address": "::1",
"gateway": "::2",
"serviceAddress": true
},
{
"address": "0.0.0.1/24",
"gateway": "0.0.0.2",
"serviceAddress": true
}
],
"maxBandwidth": null,
"monitor": true,
"mtu": 1500,
"name": "eth0",
"routerHostName": "",
"routerPortName": ""
}
],
"interfaceMtu": 1500,
"interfaceName": "eth0",
"ip6Address": "::1",
"ip6Gateway": "::2",
"ipAddress": "0.0.0.1",
"ipGateway": "0.0.0.2",
"ipNetmask": "255.255.255.0",
"mgmtIpAddress": "",
"mgmtIpGateway": "",
"mgmtIpNetmask": "",
"offlineReason": "",
"physLocationId": 1,
"profileNames": ["ATS_MID_TIER_CACHE"],
"statusId": 3,
"tcpPort": 80,
"typeId": 12
}
Response Structure
- cachegroup
A string that is the name of the Cache Group to which the server belongs
- cachegroupId
An integer that is the ID of the Cache Group to which the server belongs
- cdnId
The integral, unique identifier of the CDN to which the server belongs
- cdnName
Name of the CDN to which the server belongs
- configUpdateTime
The last time an update was requested for this server. This field defaults to standard epoch
- configApplyTime
The last time an update was applied for this server. This field defaults to standard epoch
- domainName
The domain part of the server’s FQDN
- guid
An identifier used to uniquely identify the server
Note
This is a legacy key which only still exists for compatibility reasons - it should always be
null
- hostName
The (short) hostname of the server
- httpsPort
The port on which the server listens for incoming HTTPS connections/requests
- id
An integral, unique identifier for this server
- iloIpAddress
The IPv4 address of the server’s ILO service1
- iloIpGateway
The IPv4 gateway address of the server’s ILO service1
- iloIpNetmask
The IPv4 subnet mask of the server’s ILO service1
- iloPassword
The password of the of the server’s ILO service user1 - displays as simply
******
if the currently logged-in user does not have the ‘admin’ or ‘operations’ Role(s) <Role>- iloUsername
The user name for the server’s ILO service1
- interfaces
A set of the network interfaces in use by the server. In most scenarios, only one will be present, but it is illegal for this set to be an empty collection.
- ipAddresses
A set of objects representing IP Addresses assigned to this network interface. In most scenarios, only one or two (usually one IPv4 address and one IPv6 address) will be present, but it is illegal for this set to be an empty collection.
- address
The actual IP address, including any mask as a CIDR-notation suffix
- gateway
Either the IP address of the network gateway for this address, or
null
to signify that no such gateway exists- serviceAddress
A boolean that describes whether or not the server’s main service is available at this IP address. When this property is
true
, the IP address is referred to as a “service address”. It is illegal for a server to not have at least one service address. It is also illegal for a server to have more than one service address of the same address family (i.e. more than one IPv4 service address and/or more than one IPv6 address). Finally, all service addresses for a server must be contained within one interface - which is therefore sometimes referred to as the “service interface” for the server.
- maxBandwidth
The maximum healthy bandwidth allowed for this interface. If bandwidth exceeds this limit, Traffic Monitors will consider the entire server unhealthy - which includes all configured network interfaces. If this is
null
, it has the meaning “no limit”. It has no effect ifmonitor
is not true for this interface.See also
- monitor
A boolean which describes whether or not this interface should be monitored by Traffic Monitor for statistics and health consideration.
- mtu
The MTU of this interface. If it is
null
, it may be assumed that the information is either not available or not applicable for this interface.- name
The name of the interface. No two interfaces of the same server may share a name. It is the same as the network interface’s device name on the server, e.g.
eth0
.- routerPortName
The human-readable name of the router responsible for reaching this server’s interface.
- routerPortName
The human-readable name of the port used by the router responsible for reaching this server’s interface.
- lastUpdated
The date and time at which this server description was last modified
- mgmtIpAddress
The IPv4 address of some network interface on the server used for ‘management’
Deprecated since version 3.0: This field is deprecated and will be removed in a future API version. Operators should migrate this data into the
interfaces
property of the server.- mgmtIpGateway
The IPv4 address of a gateway used by some network interface on the server used for ‘management’
Deprecated since version 3.0: This field is deprecated and will be removed in a future API version. Operators should migrate this data into the
interfaces
property of the server.- mgmtIpNetmask
The IPv4 subnet mask used by some network interface on the server used for ‘management’
Deprecated since version 3.0: This field is deprecated and will be removed in a future API version. Operators should migrate this data into the
interfaces
property of the server.- offlineReason
A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status
- physLocation
The name of the Physical Location where the server resides
- physLocationId
An integral, unique identifier for the Physical Location where the server resides
- profileNames
- revalPending
A boolean value which, if
true
indicates that this server has pending content invalidation/revalidation- revalUpdateTime
The last time a content invalidation/revalidation request was submitted for this server. This field defaults to standard epoch
- revalApplyTime
The last time a content invalidation/revalidation request was applied by this server. This field defaults to standard epoch
- rack
A string indicating “server rack” location
- status
The status of the server
See also
- statusId
The integral, unique identifier of the status of this server
See also
- tcpPort
The port on which this server listens for incoming TCP connections
Note
This is typically thought of as synonymous with “HTTP port”, as the port specified by
httpsPort
may also be used for incoming TCP connections.- type
The name of the ‘type’ of this server
- typeId
The integral, unique identifier of the ‘type’ of this server
- updPending
A boolean value which, if
true
, indicates that the server has updates of some kind pending, typically to be acted upon by Traffic Control Cache Config (T3C, formerly ORT)- xmppId
A system-generated UUID used to generate a server hashId for use in Traffic Router’s consistent hashing algorithm. This value is set when a server is created and cannot be changed afterwards.
- xmppPasswd
The password used in XMPP communications with the server
HTTP/1.1 201 Created
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Tue, 19 May 2020 17:34:40 GMT; Max-Age=3600; HttpOnly
Vary: Accept-Encoding
X-Server-Name: traffic_ops_golang/
Date: Tue, 19 May 2020 16:34:40 GMT
Content-Length: 562
{ "alerts": [
{
"text": "Server created",
"level": "success"
}
],
"response": {
"cachegroup": "CDN_in_a_Box_Mid",
"cachegroupId": 6,
"cdnId": 2,
"cdnName": "CDN-in-a-Box",
"configUpdateTime": "1969-12-31T17:00:00-07:00",
"configApplyTime": "1969-12-31T17:00:00-07:00",
"domainName": "infra.ciab.test",
"guid": null,
"hostName": "test",
"httpsPort": 443,
"id": 14,
"iloIpAddress": "",
"iloIpGateway": "",
"iloIpNetmask": "",
"iloPassword": "",
"iloUsername": "",
"lastUpdated": "2020-05-19 16:34:40+00",
"mgmtIpAddress": "",
"mgmtIpGateway": "",
"mgmtIpNetmask": "",
"offlineReason": "",
"physLocation": "Apachecon North America 2018",
"physLocationId": 1,
"profileNames": ["ATS_MID_TIER_CACHE"],
"rack": null,
"revalPending": false,
"revalUpdateTime": "1969-12-31T17:00:00-07:00",
"revalApplyTime": "1969-12-31T17:00:00-07:00",
"status": "REPORTED",
"statusId": 3,
"tcpPort": 80,
"type": "MID",
"typeId": 12,
"updPending": false,
"xmppId": null,
"xmppPasswd": null,
"interfaces": [
{
"ipAddresses": [
{
"address": "::1",
"gateway": "::2",
"serviceAddress": true
},
{
"address": "0.0.0.1/24",
"gateway": "0.0.0.2",
"serviceAddress": true
}
],
"maxBandwidth": null,
"monitor": true,
"mtu": 1500,
"name": "eth0",
"routerHostName": "",
"routerPortName": ""
}
]
}}