docs/source/api/system_info.rst

..
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..
..     http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
..

.. _to-api-system-info:

***************
``system/info``
***************

``GET``
=======
:Auth. Required: Yes
:Roles Required: None
:Response Type:  Object

Request Structure
-----------------
No parameters available.

Response Structure
------------------
:parameters: An object containing information about the Traffic Ops server

	.. note:: These are all the :term:`Parameters` in :ref:`the-global-profile`, so the keys below are merely those present by default required for Traffic Control to operate

	:default_geo_miss_latitude:  The default latitude used when geographic lookup of an IP address fails
	:default_geo_miss_longitude: The default longitude used when geographic lookup of an IP address fails
	:tm.logourl:                 This is the URL of the logo for Traffic Ops and is assumed relative to ``tm.url`` if it is a relative path
	:tm.instance_name:           The name of the Traffic Ops instance; typically used when multiple instances are active
	:tm.toolname:                The name of the Traffic Ops tool (usually "Traffic Ops") - used in several API endpoints and written in comment headers on most Apache Traffic Server (ATS) configuration files generated by Traffic Ops
	:tm.url:                     The URL for this Traffic Ops instance ) - used in several API endpoints and written in comment headers on most Apache Traffic Server (ATS) configuration files generated by Traffic Ops
	:use_reval_pending:          A string containing an integer which represents a boolean value (hold your applause); one of:

		"0"
			Do not use pending revalidations - this effectively prohibits the use of "Content Invalidation Jobs"
		"1"
			Use pending revalidations - this effectively enables the use of "Content Invalidation Jobs"

	:use_tenancy: A string containing an integer which represents a boolean value; one of:

		"0"
			Do not use tenancy - this effectively disables all ``*tenant*`` endpoints and removes tenancy restrictions on origins and :term:`Delivery Services`
		"1"
			Use tenancy - this effectively enables all ``*tenant*`` endpoints and enforces tenancy restrictions on origins and :term:`Delivery Services`

.. code-block:: http
	:caption: 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: ObxOXk1jrC1/JtrqElUICceyx9iJKJxZydEIHvAU7khTTQwt0QGvSO4ELDkdrbu3ctFo3pf3NAMaMM9tAkNokg==
	X-Server-Name: traffic_ops_golang/
	Date: Tue, 11 Dec 2018 19:06:01 GMT
	Content-Length: 285

	{ "response": {
		"parameters": {
			"default_geo_miss_latitude": "0",
			"default_geo_miss_longitude": "-1",
			"tm.instance_name": "CDN-In-A-Box",
			"tm.logourl": "/images/tc_logo.png",
			"tm.toolname": "Traffic Ops",
			"tm.url": "https://trafficops.infra.ciab.test:443/",
			"use_reval_pending": "0",
			"use_tenancy": "1"
		}
	}}